Skip to content

Latest commit

 

History

History
121 lines (79 loc) · 3.89 KB

CONTRIBUTING.md

File metadata and controls

121 lines (79 loc) · 3.89 KB
Raw

Contributing Guidelines

Contributions are welcome, and they are greatly appreciated! Every bit helps, and credit will always be given.

Commit Guidelines

Types of Contributions

There are several types of contributions that can be made:

Report Bugs

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Submit Feedback

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here's how to set up python-package-ci-cd for local development.

  1. Set up commit signing, see GitHub's documentation for details.

    !!! hint All commits going into the main repository are required to be signed, so make sure to set up commit signing before starting to make changes.

  2. Fork python-package-ci-cd into a new repository.

  3. Set up a virtual environment and install the project with its dependencies:

    • Using the helper script (recommended): 
      python scripts/contributor_setup.py

  4. Check to see if there are any open issues or pull requests that are related to the change you wish to make.

  5. Create or update an issue to track the status of your change.

  6. Use git to create a branch for local development and make your changes:

    git checkout -b name-of-your-bugfix-or-feature

  7. Update the Unreleased section in the CHANGELOG using the proper format.

  8. When you're done making changes, check that your changes conform to any code formatting requirements.

    !!! note Always remember to activate the virtual environment.

     ```console
 # Linux
 source .venv/bin/activate

 # Windows
 .venv\Scripts\activate.bat
 ```

    • To run the pre-commit checks:

      pre-commit run --all

  9. Commit and push your changes, then open a pull request from the fork back into the main repository.

    • Commit messages must be structured as follows: 
      <type>[optional scope]: <description>

[optional body]

[optional footer(s)]
    • <type> can be one of fix, feat, build, ci, docs, style, refactor, or test.
    • See the Conventional Commits website for more details on this format.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. If the pull request adds functionality, the README should be updated.
  2. The Unreleased section in the Changelog should be updated.

Code of Conduct

Please note that the python-package-ci-cd project is released with a Code of Conduct. By contributing to this project you agree to abide by its terms.