Skip to content

Contributing#

There are several ways to contribute to pyticktick, based on your level of commitment. Please read the Code of Conduct before contributing.

Opening an Issue#

For any of the following issue types, you can open a new issue and follow along with the corresponding template.

Reporting a Bug#

You can report a bug by using the bug report template on the pyticktick repository. Please make sure to do the following:

  1. Check that there is no existing issue for the bug you are reporting
  2. Ensure the bug is reproducible, and you have provided a minimal code example, following this guide
  3. Provide any applicable logs

Feature Request#

You can request a feature by using the feature request template on the pyticktick repository. Please make sure to do the following:

  1. Check that there is no existing issue for the feature you are requesting
  2. Ensure the feature is not already implemented in the latest version of pyticktick, or in the repository codebase
  3. Provide any example code or pseudocode to help demonstrate the feature
  4. Provide the endpoint, and any relevant parameters / responses (if applicable)

Documentation Improvement#

You can request to improve the documentation by using the documentation improvement template on the pyticktick repository. Please make sure to do the following:

  1. Check that there is no existing issue for the documentation improvement you are requesting
  2. Provide a link to the relevant documentation page (if applicable)

Contributing to the Documentation#

In order to contribute to the documentation, please go through the issue tracker to find an issue that you can work on. If you don't find an issue, you can create a new one.

Fork the repository and create a new branch for your changes. When you have the forked repository on your workspace, you can set up your local environment and run the documentation server locally.

This documentation attempts to follow the approach of Diátaxis. Please ensure that you bucket your changes into the appropriate section of the documentation, depending on the question you are answering. You may find that your documentation changes can be split into multiple buckets.

When you are ready to submit your changes, you can open a pull request.

Contributing to the Codebase#

In order to contribute to the codebase, please go through the issue tracker to find an issue that you can work on. If you don't find an issue, you can create a bug report or feature request.

Fork the repository and create a new branch for your changes. When you have the forked repository on your workspace, you can set up your local environment. You should try your best to follow the codebase conventions when making your changes. Once you are done editing, it's time to test your changes locally.

Once all tests pass on your machine, you can open a pull request.

Opening a Pull Request#

To open a pull request, you can follow GitHub's guide. Please adhere to the following guidelines:

  • Title
    • Do not use the auto-generated title, re-word your title to be more descriptive
    • Keep it concise and clear
  • Description
    • Link to the issue you were addressing
    • Add any relevant context to your pull request to help reviewers understand the changes you made
  • Make sure your branch is rebased against the latest commit of the main branch.
  • Make sure all tests have already passed on your machine.