Skip to content

[docs] Add a contributing guide - #174

Merged
aaronj0 merged 2 commits into
compiler-research:mainfrom
aaronj0:add-contributing-guide
Nov 2, 2026
Merged

aaronj0 merged 2 commits into
compiler-research:mainfrom
aaronj0:add-contributing-guide

Conversation

@aaronj0

@aaronj0 aaronj0 commented Oct 30, 2026

Copy link
Copy Markdown
Collaborator

Serves as a starting point.

@guitargeek guitargeek left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread CONTRIBUTING.md Outdated
Comment on lines +7 to +8
[cppyy](https://github.com/wlav/cppyy). The project is young and its APIs
still evolve, so contributions of all kinds are welcome.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[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.

Comment thread CONTRIBUTING.md Outdated
Comment on lines +54 to +55
A pull request has to pass the same checks that CI runs. Run them before you
push.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

@aaronj0

aaronj0 commented Nov 2, 2026

Copy link
Copy Markdown
Collaborator Author

Thanks @guitargeek, I've addressed both points in the follow up commit

@aaronj0
aaronj0 requested a review from guitargeek November 2, 2026 15:10

@guitargeek guitargeek left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks for addressing the comments

@aaronj0
aaronj0 merged commit 0332d76 into compiler-research:main Nov 2, 2026
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants