-
Notifications
You must be signed in to change notification settings - Fork 100
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.
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
Docs: Add new contribution guideline #1223
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few typos here and there. Other than that, LGTM! Thank you @isabelle-dr 🚀
docs/CONTRIBUTING.md
Outdated
| Contribution type | Description | | ||
|---------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| Participate in the community | What makes this tool successful is its international & diverse community. One of the best ways to contribute is simply to be part of it! Participate in the discussions, answer on the newly opened issues, help others, attend the community meetings. This is all happening on the Slack channel #gtfs-validators. | | ||
| Comment or vote on issues issues already opened. | We use the [GitHub issue tracker](https://github.com/MobilityData/gtfs-validator/issues) to capture bugs, new feature ideas and improvements. If you see an issue that is relevant to you, give a thumbs up or comment. This will increase the priority of the issue, and it will be solved earlier as a result! | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Comment or vote on issues issues already opened. | We use the [GitHub issue tracker](https://github.com/MobilityData/gtfs-validator/issues) to capture bugs, new feature ideas and improvements. If you see an issue that is relevant to you, give a thumbs up or comment. This will increase the priority of the issue, and it will be solved earlier as a result! | | |
| Comment or vote on issues issues already opened. | We use the [GitHub issue tracker](https://github.com/MobilityData/gtfs-validator/issues) to capture bugs, new feature ideas and improvements. If you see an issue that is relevant to you, give a thumbs up or comment. This will increase the priority of the issue, and it will be solved earlier as a result! | |
Co-authored-by: Maxime Armstrong <[email protected]>
Co-authored-by: Maxime Armstrong <[email protected]>
Co-authored-by: Maxime Armstrong <[email protected]>
Co-authored-by: Maxime Armstrong <[email protected]>
Co-authored-by: Maxime Armstrong <[email protected]>
Co-authored-by: Maxime Armstrong <[email protected]>
Co-authored-by: Maxime Armstrong <[email protected]>
Co-authored-by: Maxime Armstrong <[email protected]>
Co-authored-by: Maxime Armstrong <[email protected]>
What an eye @maximearmstrong! 🐅. Thanks for reviewing this. @bdferris-v2, can you have a look as well before we merge? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Small nits aside, LGTM from me. The content generally looks good and matches my general expectations for running an open-source project, so 👍. Admittedly, there is a /lot/ of content here, so not sure how many contributors will get through all of it, but it is roughly ordered from beginner => advanced, so probably fine. Thanks for putting this together!
Thank you for reviewing @bdferris-v2. I have updated the document accordingly. |
After discussion with @maximearmstrong, the GH actions aren't getting triggered because this PR only modifies documentation. Merging this PR as is! |
Summary:
This PR updates the contribution guideline to the new guideline drafted in this document.
This is part of issue #1175.
There are still a few things to improve that I've identified with @todo, and I think they can be added at a later stage.
Expected behavior:
The new Contribution Guideline appears.
Please make sure these boxes are checked before submitting your pull request - thanks!
[] Run the unit tests withgradle test
to make sure you didn't break anything[ ] Include screenshot(s) showing how this pull request works and fixes the issue(s)