Skip to content

[TASK] Document the general contribution workflow #662

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 27, 2024
Merged

[TASK] Document the general contribution workflow #662

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
703a32d
[TASK] Document the general contribution workflow
oliverklee Aug 23, 2024
bc2b878
Address review comments
oliverklee Aug 26, 2024
551870d
Running a PR is not the same as approving it.
oliverklee Aug 27, 2024
f9f93ae
Rely on the GitHub Markdown renderer to count our lists items for us
oliverklee Aug 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,26 @@ When you contribute, please take the following things into account:
Please note that this project is released with a
[Contributor Code of Conduct](../CODE_OF_CONDUCT.md). By participating in this
project, you agree to abide by its terms.

## General workflow

This is the workflow for contributing changes to this project::

1. [Fork the Git repository](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project).
1. Clone your forked repository locally and install the development
dependencies.
1. Create a local branch for your changes.
1. Add unit tests for your changes.
These tests should fail without your changes.
1. Add your changes. Your added unit tests now should pass, and no other tests
should be broken. Check that your changes follow the same coding style as the
rest of the project.
1. Add a changelog entry, newest on top.
1. Commit and push your changes.
1. [Create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)
for your changes.
1. Check that the CI build is green. (If it is not, fix the problems listed.)
Please note that for first-time contributors, you will need to wait for a
maintainer to allow your CI build to run.
1. Wait for a review by the maintainers.
1. Polish your changes as needed until they are ready to be merged.