Repository navigation
[docs] Add a contributing guide - #174
Conversation
guitargeek
left a comment
There was a problem hiding this comment.
Thank you very much for this initial push to a contributors guide! I have one nitpick, and one comment about a sentence that sends the wrong message about API stability that I would change.
| [cppyy](https://github.com/wlav/cppyy). The project is young and its APIs | ||
| still evolve, so contributions of all kinds are welcome. |
There was a problem hiding this comment.
| [cppyy](https://github.com/wlav/cppyy). The project is young and its APIs | |
| still evolve, so contributions of all kinds are welcome. | |
| [cppyy](https://github.com/wlav/cppyy). The project is young and a community is just starting to form around it, so contributions of all kinds are welcome. |
I would not mention that "APIs still evolve", personally. That might make people think they can change APIs as they see fit, but in reality the APIs have very little wiggle room to evolve because of the ROOT requirements.
| A pull request has to pass the same checks that CI runs. Run them before you | ||
| push. |
There was a problem hiding this comment.
| A pull request has to pass the same checks that CI runs. Run them before you | |
| push. | |
| A pull request has to pass the same checks that the CI runs. Run them before you | |
| push. |
I think this is not so helpful as is. I'd either drop this section, or actually list the checks that are done and how they can be ran (code formatters and linters I guess). I link to the CI yaml with the commands would already be good. Also we usually say "the CI" right?
Edit: I just saw the checks are listed later, so I think this section could be dropped.
|
Thanks @guitargeek, I've addressed both points in the follow up commit |
guitargeek
left a comment
There was a problem hiding this comment.
LGTM! Thanks for addressing the comments
Serves as a starting point.