NCAS-CMS / NCAS-CMS/cf-plot

Populate `.gitignore` from Python template

Open
#38 0 comments 0 reactions 1 assignee View on GitHub

@sadielbartholomew is already working on this.

Since Mar 11, 2024.

infrastructure
Dominant language
Python
Stars
21
Forks
11
Avg merge
7h 11m
Merged PRs (30d)
1

Description

As alluded to in #37, the .gitignore is presently very bare and many files need to be manually ignored when staging for a commit. The simplest way to get a more useful .gitignore without having to think much about what needs to be added, is to copy one from a pre-populated Python template, for example as provided by GitHub itself (now an option when you create a repo to add it, but it wasn't back in the day...) i.e. the file here.

Notably though, from looking at this template I would also like to customise it a little, e.g. to:

  • add Sphinx artefacts to be ignored, such as the .rst.txt under /build/_sources/*,
  • add data files (mostly netCDF), which we shouldn't generally touch, but might want to play around with for testing and end up writing over with edits, therefore would be good to include to ignore.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.