Skip to content

Latest commit

 

History

History
67 lines (45 loc) · 3.32 KB

CONTRIBUTING.md

File metadata and controls

67 lines (45 loc) · 3.32 KB
Raw

Contributing to Casper Staking

Thank you for considering contributing to Casper Staking! We appreciate your interest in improving our project. Please take a moment to review the following guidelines to ensure a smooth and effective collaboration.

Table of Contents

Code of Conduct

We have adopted a Code of Conduct that we expect all contributors to follow. Please make sure to review and adhere to this code to foster a positive and inclusive community.

How to Contribute

There are several ways to contribute to Casper Staking, including:

  1. Bug reports - Help us identify and fix issues.
  2. Feature requests - Suggest new ideas and improvements.
  3. Pull requests - Contribute code directly to the project.

Bug Reports

If you encounter any issues or bugs while using Casper Staking, please submit a detailed bug report. You can do this by following these steps:

  1. Verify that the bug has not been reported yet by searching through the existing issues.
  2. If the bug hasn't been reported, open a new issue and provide a clear title and description of the problem.
  3. Include steps to reproduce the bug, along with any relevant error messages or screenshots.
  4. If possible, suggest a possible fix or a way to mitigate the problem.

Feature Requests

We welcome new ideas and feature requests for Casper Staking. If you have a suggestion to improve the project, please follow these steps:

  1. Check the existing issues to see if your idea has already been discussed.
  2. If the idea is new, open a new issue and provide a clear and descriptive title and description.
  3. Clearly explain why the feature would be beneficial and any potential implementation details.

Pull Requests

We appreciate any contributions through pull requests. To contribute code to Casper Staking, please follow these steps:

  1. Fork the repository and create a new branch from main.
  2. Make your changes, ensuring that your code follows the style guidelines.
  3. Write appropriate tests to cover your changes, if applicable.
  4. Commit your changes and push the branch to your forked repository.
  5. Open a pull request from your branch to the main branch of this repository.
  6. Provide a clear title and description of the changes you made, as well as any relevant information for reviewers.

Style Guidelines

To maintain consistency throughout the codebase, please adhere to the following style guidelines:

  • Follow the existing code formatting and naming conventions.
  • Write clear and concise code with appropriate comments when necessary.
  • Use descriptive variable and function names.
  • Ensure your code passes any existing tests.
  • If you add new functionality, consider adding relevant tests.

License

By contributing to Casper Staking, you agree that your contributions will be licensed under the [MIT License