-
Notifications
You must be signed in to change notification settings - Fork 19
add CONTRIBUTING.md #321
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.md #321
Conversation
|
cc @delta1 @imaginator @KyrylR let me know what you think of this |
delta1
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ACK 2fab9ff
LGTM
|
ACK 2fab9ff LGTM In the long run, and for a more dev‑friendly (for people who are visiting repository for the first time kinda) open source approach, we could take inspiration from this: https://github.com/paradigmxyz/reth/blob/main/CONTRIBUTING.md |
|
For SimplicityHL we probably want to be more friendly. For this crate, which is pretty low-level, I'd rather not be. In neither case do we want to find ourselves running a kindergarten for low-compentence "contributors" trying to pad their resumes by wasting our time. We also do not want any code of conduct, let alone one with explicitly named conduct police. If you think there's value in one we can use the one-line ESR If you are more annoying to work with than your contributions justify, you'll be ejected. one. Maybe it would discourage would-be conduct police from joining the project. |
apoelstra
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On 2fab9ff successfully ran local tests
36e9c44 add CONTRIBUTING.md (Andrew Poelstra) Pull request description: Adds a contributing.md file. Based on the one [in rust-simplicity](BlockstreamResearch/rust-simplicity#321) but I tried to be more friendly and to usefully redirect people, since we expect this repository to be the "point of first contact" for many would-be Simplicity developers. ACKs for top commit: delta1: ACK 36e9c44 KyrylR: ACK 36e9c44 Tree-SHA512: be650ffabb564cfa9e906174a84637fdcd93e2a7f8892c584a1c4c8c417aec706351e1b27e6a4dd9ed6208a54f2d37e5c5da219f31b395af384e6f1ce9a0b8fd
If this looks good I'll replicate it for SimplicityHL and rust-elements. (simplicity-webide, simplicity-unchained, and other less-mature projects should probably have a different, less strict, policy.)