-
Notifications
You must be signed in to change notification settings - Fork 16
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
Added Contributor.md #151
base: main
Are you sure you want to change the base?
Added Contributor.md #151
Conversation
git push origin feature/your-feature-name | ||
``` | ||
|
||
### 9. Push Your Changes |
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.
Duplicate of step 8.
``` | ||
|
||
### 7. Commit Your Changes | ||
Write a clear and concise commit message. |
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.
Commit messages should addhere to conventional commits standard: https://www.conventionalcommits.org/en/v1.0.0/#specification
(the example below should be ammended to reflect this).
Maybe also highlight expected commit structure: each commit should contain a coherent logical change, a commit should depend only on earlier commits, fixes/changes/updates should be fixed up into existing commits rather than addded as new commits, etc.
``` | ||
|
||
### 10. Create a Pull Request | ||
Open a pull request (PR) to the main repository. Include a detailed description of your changes and any related issue numbers. |
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.
I would replace "detailed description" with just "description" or "summary". Detailed description should be part of the commit messages, rather than the pull request message. There is nothing wrong with having the details in the pull request as well, however, if it's one or the other, we should be encouraging people to write more detailed commit messages, not more detailed pull requests.
cd project-name | ||
``` | ||
|
||
### 2. Fork the Repository |
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.
### 2. Fork the Repository | |
### 2. Fork the Repository |
The title above is incorrect!
## Code of Conduct | ||
Please read and adhere to our [Code of Conduct](https://github.com/veraison/corim/blob/main/CODE_OF_CONDUCT.md). Respectful and inclusive behavior is expected from all contributors. | ||
|
||
## Guidelines for Contributions |
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.
This section Guidelines for Contributions
should now be re-worked/moved and aligned with your top level Contributor Guidelines for smooth logical flow!
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.
Thank you for the PR:
See my comments and please address them!
Fix #150
Description :