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
doc: GRASS Programming Style Guide #3569
Conversation
If I recall correctly, there is a special handling for a file named CONTRIBUTING.md, a bit like README files. If we really want to use a file in the doc subfolder, we could create a contributing file and link to the full docs in it.
|
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.
Looks good to me, it covers all aspects simply and concisely including examples :)
The docs are here: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors There are multiple paths that GitHub's UI will integrate these contribution guidelines on PRs for new users, or for other users if that document changes since their last contribution. I think we should take advantage of it instead of inventing our own and being left to make it discoverable by our own too. Our page looks like this: |
The idea with this style guide is to link it from the CONTRIBUTING.md file. That file needs some improvement, but that would be a different PR. |
Perfect then |
IMHO this should go into G8.4.0, no need to postpone. A nice document! |
This is not published as part of the documentation, so I don't know where this will be visible in the release except release notes (which is nice), but we need this to be in the code for GSoC so we don't have to link a file in a PR. |
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.
Thanks for addressing all the issues.
This is an attempt to consolidate and update documentation for code contributors into a style guide:
I would appreciate any feedback on this. For example I don't have a lot about pylint usage there or best practices in C.