-
Notifications
You must be signed in to change notification settings - Fork 225
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 file #4676
base: dev
Are you sure you want to change the base?
Add contributing.md file #4676
Conversation
Dear @MParlikar , @sacherjj , @ACStoneCL , @ipopescu |
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 have reviewed 3 versions of the contributing.md file and they need to be more consistent. Please check them and decide which version to keep.
Also, please update the png to reflect the current branch strategy in the casper-node.
|
||
Here’s how you can contribute code: | ||
|
||
#### Steps to Submit Code |
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.
Why is the formatting so different than what was submitted here: casper-network/.github#1 (comment). Could you please make them consistent?
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 comment still needs to be addressed.
CONTRIBUTING.md
Outdated
|
||
2. **Make your changes**: Ensure your code complies with the existing style and architecture. Keep your changes focused, and if they are broad, consider dividing them into smaller PRs for easier review. | ||
3. **Test your changes**: Execute existing tests and add new ones as needed. Your code should pass all existing tests, and new functionalities should come with accompanying tests. | ||
- **Step 3.1:** Enable Automated Testing [Refer to GitHub’s [Automating builds and tests - GitHub Docs](https://docs.github.com/en/actions/automating-builds-and-tests) for more information]. |
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.
- **Step 3.1:** Enable Automated Testing [Refer to GitHub’s [Automating builds and tests - GitHub Docs](https://docs.github.com/en/actions/automating-builds-and-tests) for more information]. | |
- **Step 3.1:** Enable Automated Testing. For more information, refer to GitHub’s [Automating builds and tests - GitHub Docs](https://docs.github.com/en/actions/automating-builds-and-tests). |
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 comment needs to be addressed.
|
||
Refer to the Casper Pull Request Workflow below; | ||
|
||
![Casper PR Workflow](/casper-node/images/casper_pull_request_flow.png) |
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 diagram needs to be updated as noted in other PRs.
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 comment needs to be addressed.
Hi @ipopescu , Thank you very much for your feedback/comments. I have now incorporated the comments. Please review and let me know your feedback. |
@devendran-m, there are still unresolved comments. Please take a look and let me know if you need help. Also, please fix the linting. |
Housekeeping - Moving it to backlog for future sprint planning |
Please consider the following when creating a PR:
CONTRIBUTING.md
file to the repository. The content of the CONTRIBUTING.md file contains details to the users/community members on how they can contribute, process they have follow when contributing and steps to adhere to during the process.