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 to casper-network GitHub Org #1

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

devendran-m
Copy link

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:   profile/CODE_OF_CONDUCT.md
        new file:   profile/CONTRIBUTING.md
        new file:   profile/PROPOSALS.md
        new file:   profile/README.md
        new file:   profile/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
Author

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

profile/CODE_OF_CONDUCT.md Outdated Show resolved Hide resolved
profile/CODE_OF_CONDUCT.md Outdated Show resolved Hide resolved
profile/CODE_OF_CONDUCT.md Outdated Show resolved Hide resolved
profile/CODE_OF_CONDUCT.md Outdated Show resolved Hide resolved
profile/CODE_OF_CONDUCT.md Outdated Show resolved Hide resolved

Upon successfully submitting the PR, the Casper team will review the PR or reach out accordingly.

### 4. Creating Pull Requests

Choose a reason for hiding this comment

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

Please match the formatting already discussed and updated here.

Copy link

@ipopescu ipopescu Jun 4, 2024

Choose a reason for hiding this comment

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

@devendran-m This comment has not been addressed. At the minimum, remove the following heading and incorrect punctuation:

Casper Pull Request Workflow:

Please refer to the Casper Pull Request Workflow below;

Comment on lines 137 to 139
3. Enhancement Proposals (CEP)

To propose major changes or enhancements to the Casper Node, we encourage you to submit a Casper Enhancement Proposal (CEP). The CEP process is designed to provide a structured approach to new features, enabling organized discussion and review.

Choose a reason for hiding this comment

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

Should these lines be deleted? They seem to be left over from something and already covered below.

Suggested change
3. Enhancement Proposals (CEP)
To propose major changes or enhancements to the Casper Node, we encourage you to submit a Casper Enhancement Proposal (CEP). The CEP process is designed to provide a structured approach to new features, enabling organized discussion and review.


1. **Familiarize Yourself**: Review the [CEP README](https://github.com/casper-network/ceps/blob/main/README.md) to understand the process and what is expected in a CEP.
2. **Draft Your Proposal**: Write a draft of your CEP using the provided [template](https://github.com/casper-network/ceps/blob/main/0000-template.md).
3. **Submit a Pull Request**: Open a PR in the [CEP repository](https://github.com/casper-network/ceps) with your proposal. Ensure you follow all guidelines for submission.

Choose a reason for hiding this comment

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

Suggested change
3. **Submit a Pull Request**: Open a PR in the [CEP repository](https://github.com/casper-network/ceps) with your proposal. Ensure you follow all guidelines for submission.
3. **Submit a Pull Request**: Open a PR in the [CEP repository](https://github.com/casper-network/ceps) with your proposal. Please make sure you follow all submission guidelines.

5. **Final Decision**: After discussion, the maintainers will decide whether to accept the CEP. If accepted, it will be merged into the repository and implemented as planned.


### 7. Contributing New Projects to Casper Network

Choose a reason for hiding this comment

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

Suggested change
### 7. Contributing New Projects to Casper Network
### 7. Contributing New Projects to the Casper Ecosystem


### 7. Contributing New Projects to Casper Network

This section is specifically created to explain the mandatory requirements that the Community Developers/Teams are required to follow when contributing new projects to the Casper Network.

Choose a reason for hiding this comment

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

The Casper Network is one of the many Casper networks (Mainnet, Testnet, private etc). We need to review the term used here.

Suggested change
This section is specifically created to explain the mandatory requirements that the Community Developers/Teams are required to follow when contributing new projects to the Casper Network.
This section is specifically created to explain the mandatory requirements that Community Developers/Teams must follow when contributing new projects to the Casper Ecosystem.

@devendran-m
Copy link
Author

Hi @ipopescu ,
Thank you for your feedback. I have incorporated the comments. Please review and provide your approval if everything is okay.

@ipopescu
Copy link

ipopescu commented Jun 4, 2024

@devendran-m, many of my comments have not been addressed and are still in an unresolved state.
Also, the diagram is still incorrect and not representative of the casper branching strategy. Please update it or remove it until it gets updated.
Let me know if you need help with the editing updates and I will make them directly.

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