Docs: Add new contribution guideline #1223
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
maximearmstrong
approved these changes
Aug 1, 2022
There was a problem hiding this comment.
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.
Suggested change
| | 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 <46797220+maximearmstrong@users.noreply.github.com>
Co-authored-by: Maxime Armstrong <46797220+maximearmstrong@users.noreply.github.com>
Co-authored-by: Maxime Armstrong <46797220+maximearmstrong@users.noreply.github.com>
Co-authored-by: Maxime Armstrong <46797220+maximearmstrong@users.noreply.github.com>
Co-authored-by: Maxime Armstrong <46797220+maximearmstrong@users.noreply.github.com>
Co-authored-by: Maxime Armstrong <46797220+maximearmstrong@users.noreply.github.com>
Co-authored-by: Maxime Armstrong <46797220+maximearmstrong@users.noreply.github.com>
Co-authored-by: Maxime Armstrong <46797220+maximearmstrong@users.noreply.github.com>
Co-authored-by: Maxime Armstrong <46797220+maximearmstrong@users.noreply.github.com>
|
What an eye @maximearmstrong! 🐅. Thanks for reviewing this. @bdferris-v2, can you have a look as well before we merge? |
bdferris-v2
reviewed
Aug 3, 2022
bdferris-v2
reviewed
Aug 3, 2022
bdferris-v2
reviewed
Aug 3, 2022
bdferris-v2
reviewed
Aug 3, 2022
There was a problem hiding this comment.
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! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 testto make sure you didn't break anything[ ] Include screenshot(s) showing how this pull request works and fixes the issue(s)