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 guidelines document #4

Closed
jGaboardi opened this issue Oct 3, 2024 · 4 comments · Fixed by #45
Closed

Add contributing guidelines document #4

jGaboardi opened this issue Oct 3, 2024 · 4 comments · Fixed by #45
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@jGaboardi
Copy link
Collaborator

Add contributing guidelines document

@jGaboardi jGaboardi added the documentation Improvements or additions to documentation label Oct 3, 2024
@jGaboardi
Copy link
Collaborator Author

jGaboardi commented Oct 16, 2024

xref: #44 (comment)

Should our contributing guidelines:

  • (a) go in the README.md
  • (b) go in a CONTRIBUTING.md
  • (c) go in both
  • (d) go somewhere else?

I think probably (c), but what's yall's thoughts @anastassiavybornova @martinfleis ?

@martinfleis
Copy link
Contributor

B.

@martinfleis
Copy link
Contributor

I have two reasons for that. One is that I see ReadMe and contributing guide as document for different audience, where Readme is part of the user-facing documentation (hence no A). And second is that I dislike having the same information at two places at the same time as they will inevitably get out of sync in time (hence no C).

@anastassiavybornova
Copy link
Collaborator

Agree with (b)! (and it will be linked in the README so no need for (c) )

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants