Contributing to timetracker-csv

We welcome contributions to timetracker-csv, whether it's through reporting bugs, improving the documentation, testing releases, engaging in discussion on features and bugs, or writing code.

Code of Conduct

Before starting, please read the Code of Conduct.

Reporting Bugs

Please report bugs by opening a new issue and describing it as well as possible. Many bugs are specific to a particular operating system and Python version, so please include that information!

Editing Documentation

If you find a typo or a mistake in the docs, please fix it right away and send a pull request. If you're unsure what to change but still see a problem, you can open a new issue with the "Documentation change" type.

To edit the documentation, edit the docs/*.md files on the main branch. You can see the result by running make mkdoc inside the project's root directory, then navigating your browser to localhost:8000.

External editors and tips and tricks

If you'd like to share a timetracker-csv command line trick that you find useful, you may find it worthwhile to add it to the "Tips and Tricks" section.

Testing

Much of the work of maintaining timetracker-csv involves testing rather than coding. We welcome tests.

Submitting feature requests and ideas

If you have a feature request or idea for timetracker-csv, please open a new issue and describe the goal of the feature, and any relevant use cases. We'll discuss the issue with you, and decide if it's a good fit for the project.

When discussing new features, please keep in mind our design goals. timetracker-csv strives to do one thing well. To us, that means:

being nimble
having a simple interface
avoiding duplicating functionality

Developing

Pull requests should be made on the main branch.

Updating automated tests

When resolving bugs or adding new functionality, please add tests to prevent that functionality from breaking in the future. If you notice any functionality that isn't covered in the tests, feel free to submit a test-only pull request as well.

For testing, timetracker-csv uses pytest for unit tests. All tests are in the tests folder.

Submitting pull requests

When you're ready, feel free to submit a pull request (PR). The continuous integration pipeline will run automated tests on your PR within a matter of minutes and will report back any issues it has found with your code across a variety of environments.

The pull request template contains a checklist full of housekeeping items. Please fill them out as necessary when you submit.

If a pull request contains failing tests, it probably will not be reviewed, and it definitely will not be approved. However, if you need help resolving a failing test, please mention that in your PR.

Finding things to work on

You can search the timetracker-csv GitHub issues by label for things to work on. Here are some labels worth searching:

A note for new programmers and programmers new to Python

If you have a question, please don't hesitate to ask! Python is known for its welcoming community and openness to novice programmers, so feel free to fork the code and play around with it! If you create something you want to share with us, please create a pull request. We never expect pull requests to be perfect, idiomatic, instantly mergeable code. We can work through it together!