-
Notifications
You must be signed in to change notification settings - Fork 501
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
Add CONTRIBUTING.md #668
Add CONTRIBUTING.md #668
Conversation
This lays out the philosophy behind the project, and how it should be maintained.
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.
Hi @simonhammes Thanks for getting this updated! Much appreciated.
Even though the PR is still marked as draft, I though I'd give you some feedback already. Hope it helps! Please let me know if you have any questions.
Aside from the inline remarks:
README
The README
contains some information at the bottom about Testing and Contributing.
I think it would be a good idea to remove that information and replace it with a link to this CONTRIBUTING
document.
I'd also like to suggest checking if there is anything mentioned in the information at the bottom of the README
which isn't covered by the currently proposed CONTRIBUTING
document and if so, to update the CONTRIBUTING
doc.
Please note: while in the line remarks I have used inline links, it is good practice to move the links to the end of each section in a markdown document (but the "suggest" feature for PR reviews doesn't really play nice with that).
@simonhammes Just so you know, we think you are doing a great, momentous job with your work on this PR. Please see our feedback as encouragement. Will you have time to update the PR in the near future ? I'd love to get this ready & merged! If not, please let us know and we'll be happy to sort out the next iteration. |
@simonhammes 👆🏻 Could you please let us know if you will continue with this PR or want us to take over ? |
This PR has been superseded by an updated version in #762, which has now been merged. Thanks @simonhammes for helping us get this over the finish line. |
Closes #278
Fixes #475