Add CONTRIBUTING file #48
Conversation
This adds a generic CONTRIBUTING.md file that explains the basic procedure.
I assume you talk about #3 (#48 being this PR :). Before making some comments on the file but I would like to discuss a broader question. While it's good to have a CONTRIBUTING file (most notably because GitHub automatically links to it when opening issues), perhaps it's better to describe most of the process in GitHub wikis. For instance, I think that the notebook guidelines would better fit on a wiki page. Similarly for the contribution process. More generally, the pros of a wiki page is that it's easier to edit and it looks better. The cons is that the edits are not part of a PR process. So we could do a minimal CONTRIBUTING file and link to some wiki pages. What do you think ? Also, while talking globally, the file might be a bit too advanced. Maybe it's better to invite users to use the Discussion tab instead of explaining issues and PR. |
|
I'm not opposed to any of that, if that's the way you want to do it, go for it. I was trying to speed up the process. Concretely about this PR, what do you think of having a CONTRIBUTING file? Is this something you want or not? |
| We use GitHub Actions to check notebooks for linting and formatting, please make sure your notebook passes those checks! | ||
|
|
||
| ## Reporting Issues | ||
|
|
There was a problem hiding this comment.
Can we also suggest to open a discussion ? Something like "If you have questions on the content or want to suggest improvements, you can open a discussion.". Maybe we can also point people to ask.igwn.org.
There was a problem hiding this comment.
It's not super clear but I was suggesting to add this line at the beginning of the "Reporting issue" section.
| If you find a bug or have a suggestion, please open an issue. | ||
|
|
There was a problem hiding this comment.
Given the above comment, I would remove "or have a suggestion". Also, include a link to the issue page (https://github.com/gw-odw/odw/issues).
| ## Pull Request Process | ||
|
|
||
| 1. Fork the repository | ||
| 2. Create a new feature or bug fix branch (`git checkout -b your-feature-name`) | ||
| 3. Commit your changes with a clear message | ||
| 4. Push to your fork (`git push origin your-feature-name`) | ||
| 5. Open a Pull Request and provide a detailed description | ||
|
|
||
| We use GitHub Actions to check notebooks for linting and formatting, please make sure your notebook passes those checks! | ||
|
|
There was a problem hiding this comment.
I think this section is a bit too technical for new users and not super useful for experienced users. So I would suppress it except the last sentence which could go in the previous section.
I agree, let's start with this. I made some comments. |
This adds a generic CONTRIBUTING.md file that explains the basic procedure.