chore: Add CONTRIBUTING.md #189
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
I guess I was an inspiration with my mess PR to add the contributing guide, hahah! :D but it looks great and very useful!
Just thoughts, maybe for new user it could be helpful having an example how the conventional commit would look like. Also, not sure if branch naming matters?
|
Thanks for the comments! I was actually curious how you set the project up. I'm a bit obsessed with the conventional commits but I'm sure we also use it for our changelog, so it has a purpose. Will add that part 😊 Speaking of branches: I don't think it really matters as long as it is understandable. Will mention that. (Also I did not forget about the PR but this is something that I postponed a bit too much.) |
|
Cool, that's clear, thanks! Hmm, I set the project up by first downloading Rust (as that is something I have no prior experience of, but have started thinking about learning it), and then I think I just ran the Makefile "edit" if I recall right.. Rye also something new for me that need to look up :) |
There was a problem hiding this comment.
Hey @baggiponte, thanks for including me in the review.
I left a few nitpicks and some food for thoughts 😁
CONTRIBUTING.md
Outdated
| This guide covers the following: | ||
|
|
||
| 1. Reporting an issue or a feature request. | ||
| 2. Contributing to the code base. | ||
| 3. Contributing to the documentation. |
There was a problem hiding this comment.
Just some food for thoughts: consider adding a TOC with links?
| This guide covers the following: | |
| 1. Reporting an issue or a feature request. | |
| 2. Contributing to the code base. | |
| 3. Contributing to the documentation. | |
| This guide covers the following: | |
| 1. [Reporting an issue or a feature request](#opening-an-issue). | |
| 2. [Contributing to the code base](#contributing-to-the-codebase). | |
| * [Picking an issue](#picking-an-issue) | |
| * [Set up your local environment](#set-up-your-local-environment) | |
| * [While working on your issue](#while-working-on-your-issue) | |
| * [Pull requests](#pull-requests) | |
| 3. [Contributing to the documentation](#contributing-to-the-documentation). | |
| 4. [Credits](#credits) |
Note: I am not sure about the rendering
|
|
||
| 2. **Clone the repository locally**. | ||
|
|
||
| ```bash |
There was a problem hiding this comment.
More ideas, make one expanded and the other two collapsed html details
Co-authored-by: Francesco Bruzzesi <42817048+FBruzzesi@users.noreply.github.com>
Co-authored-by: Francesco Bruzzesi <42817048+FBruzzesi@users.noreply.github.com>
Co-authored-by: Francesco Bruzzesi <42817048+FBruzzesi@users.noreply.github.com>
Co-authored-by: miroslaavi <93781226+miroslaavi@users.noreply.github.com>
Adding a draft for CONTRIBUTING.md. Would like to ask for a review to @ngriffiths13, @FBruzzesi, @miroslaavi who is working on a PR and installed the project locally, and also @ rodrigogiraoserrao because he says they are important (🤪).