Skip to content
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

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from

Conversation

devendran-m
Copy link
Contributor

Please consider the following when creating a PR:

  • Provide a useful description of this PR, suitably verbose, aimed at helping reviewers and contributors
  • This PR is created to add 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.
  • Update all relevant changelogs
  • Changelog;
        new file:   CONTRIBUTING.md
        new file:   images/casper_pull_request_flow.png
  • Provide a link to the GitHub issue relating to this PR
  • N/A
  • Identify if any downstream impact as in to, SDKs, SmartContracts etc
  • This is a information document for community members, users and therefore no downstream impact is anticipated.

@devendran-m
Copy link
Contributor Author

Dear @MParlikar , @sacherjj , @ACStoneCL , @ipopescu
I have created this PR to add CONTRIBUTING.md file to the casper-node repo as per the direction from Medha. Could you review the content and let me know your comments?

Copy link
Contributor

@ipopescu ipopescu left a 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.

CONTRIBUTING.md Outdated Show resolved Hide resolved

Here’s how you can contribute code:

#### Steps to Submit Code
Copy link
Contributor

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?

Copy link
Contributor

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].
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **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).

Copy link
Contributor

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.

CONTRIBUTING.md Outdated Show resolved Hide resolved

Refer to the Casper Pull Request Workflow below;

![Casper PR Workflow](/casper-node/images/casper_pull_request_flow.png)
Copy link
Contributor

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.

Copy link
Contributor

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.

@devendran-m
Copy link
Contributor Author

Hi @ipopescu ,

Thank you very much for your feedback/comments. I have now incorporated the comments. Please review and let me know your feedback.

@bradjohnl bradjohnl self-requested a review May 22, 2024 08:07
@ipopescu
Copy link
Contributor

ipopescu commented Jun 4, 2024

@devendran-m, there are still unresolved comments. Please take a look and let me know if you need help. Also, please fix the linting.

@devendran-m
Copy link
Contributor Author

Housekeeping - Moving it to backlog for future sprint planning

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants