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

Contributing guidelines are unclear and overwhelming #4

Open
annefou opened this issue Oct 11, 2019 · 2 comments
Open

Contributing guidelines are unclear and overwhelming #4

annefou opened this issue Oct 11, 2019 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@annefou
Copy link
Collaborator

annefou commented Oct 11, 2019

@sarambl Thanks for your feedback on the contributing guidelines. Here is the plan to make it clearer. What do you think?

  • Make it clear that one has to update the master branch only
  • Explain where to add new entries in the table of content
  • Explain how to upload new documents (markdown, ipynb, images) and where to place them (images in images folder, etc.)
  • Split contributing guidelines as they are overwhelming:
    - General introduction on contributing to github projects
    - Make your first contributions
    - Learn to collaborate to Open Science projects

I am busy today but will be working on it as soon as possible.

@sarambl
Copy link
Collaborator

sarambl commented Oct 11, 2019

I think this sounds very good indeed!
I think my thought was that it would be nice if it started simple and became progressively more complicated (and this seems to be what you are outlining now). So that you feel comfortable trying to add/change something without the whole thing.

@annefou
Copy link
Collaborator Author

annefou commented Oct 17, 2019

@sarambl I have updated contribution guidelines. Would you mind reviewing and giving your feedback?

@annefou annefou added the enhancement New feature or request label Oct 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants