Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (39 loc) · 2.88 KB

CONTRIBUTING.md

File metadata and controls

57 lines (39 loc) · 2.88 KB
Raw

Contributing to casper-nctl

First off, thank you for considering contributing to casper-nctl. It's people like you that make the Casper community great. We welcome any type of contribution, not just code.

Where to start?

There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into casper-nctl itself.

Getting Started

To get started with setting up the project locally, please refer to the main README.md file for detailed instructions on installation and usage.

Making Changes

  1. Fork the repository on GitHub.
  2. Create a new branch for your changes.
  3. Make your changes in your forked repository's new branch.
  4. Test your changes thoroughly.
  5. Commit your changes with a clear and descriptive commit message.
  6. Push your changes to your fork.
  7. Open a pull request to the dev branch of the main casper-nctl repository.

Pull Request Guidelines

  • Please make sure your pull request has a clear title and description.
  • Explain the rationale behind your changes.
  • If your pull request addresses an existing issue, please link to it.
  • Make sure your code adheres to the existing style of the project.

Sign your work

We use the Developer Certificate of Origin (DCO) as a additional safeguard for the casper-nctl project. This is a well established and widely used mechanism to assure contributors have confirmed their right to license their contribution under the project's license. Please read developer-certificate-of-origin. If you can certify it, then just add a line to every git commit message:

  Signed-off-by: Random J Developer <random@developer.example.org>

Use your real name (sorry, no pseudonyms or anonymous contributions). If you set your user.name and user.email git configs, you can sign your commit automatically with git commit -s. You can also use git aliases like git config --global alias.ci 'commit -s'. Now you can commit with git ci and the commit will be signed.

Questions?

If you have any questions, feel free to reach out to us in the Casper Developers Group on Telegram or the official Casper Discord server.

We look forward to your contributions!