-
Notifications
You must be signed in to change notification settings - Fork 13
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
Publish contributing guidelines #186
Comments
FYI @theengineear |
Thanks for putting this forward, @klebba . It definitely will be helpful for folks such as myself stopping by to contribute :)
Would this include bugfixes or documentation updates? I think it would be good to specify that this longer process is for refactors and new features, but I think something like smaller bugfixes and documentation updates should have as low a barrier as possible, so long as the change is small/straightfoward and doesn't change any APIs. Another thing that would be good while we're at it is to define templates for issues, pull request templates, etc. Since the project is relatively low volume/visibility still, these could be much simpler than the ones in lit/lit. My favorite issue template for bugs was something like:
GitHub allows templates for multiple issue types as well, so we could do them based on features/bugs/documentation requests (such as requests for cookbook examples) This could be a separate issue if you prefer, though. If you like, I could create a PR to include these items, as well as some contributor text including the rules you mentioned above. I actually kind of like writing documentation :) |
Developers have found their way to this project organically (cool!). Some folks have graciously offered pull requests, however we still have not published any guidance regarding what is expected of contributors.
We'll need to spell out a few basics in
doc/CONTRIBUTING.md
:Look to other projects for examples, e.g.:
The text was updated successfully, but these errors were encountered: