Add contributing.md file #4676
Add contributing.md file #4676
Conversation
devendran-m
requested review from
sacherjj,
MParlikar,
ipopescu and
ACStone-MTS
|
Dear @MParlikar , @sacherjj , @ACStoneCL , @ipopescu |
|
|
||
| Here’s how you can contribute code: | ||
|
|
||
| #### Steps to Submit Code |
There was a problem hiding this comment.
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.
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.
| - **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). |
|
|
||
| Refer to the Casper Pull Request Workflow below; | ||
|
|
||
|  |
There was a problem hiding this comment.
This diagram needs to be updated as noted in other PRs.
|
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.mdfile 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.new file: CONTRIBUTING.md new file: images/casper_pull_request_flow.png