Skip to content
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

Closed
wants to merge 9 commits into from
Closed

Add CONTRIBUTING.md #668

wants to merge 9 commits into from

Conversation

simonhammes
Copy link
Contributor

@simonhammes simonhammes commented Jan 23, 2022

Closes #278
Fixes #475

Copy link
Member

@jrfnl jrfnl left a 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).

CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
@jrfnl
Copy link
Member

jrfnl commented Feb 28, 2022

@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.

@jrfnl
Copy link
Member

jrfnl commented Apr 25, 2022

@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 ?

@jrfnl jrfnl mentioned this pull request Jul 12, 2022
@jrfnl
Copy link
Member

jrfnl commented Jul 25, 2022

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.

@simonhammes simonhammes deleted the add/contributing-md branch August 4, 2022 19:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve testing instructions
4 participants