Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (38 loc) · 2.77 KB

CONTRIBUTING.md

File metadata and controls

55 lines (38 loc) · 2.77 KB

Contributing to Crynux Node

First and foremost, thank you for your interest in contributing to Crynux Node! We welcome any form of contribution, whether it's reporting bugs, suggesting new features, or submitting code.

This guide is intended to help you get started with your contributions.

Code of Conduct

To foster an open and welcoming environment, we require all contributors and community members to adhere to our Code of Conduct. Please take a moment to read and understand it before participating.

How to Contribute

We use GitHub Issues to track bugs and feature requests. Before you start writing code, please check the existing issues to see if there's one related to your contribution.

Reporting Bugs

If you find a bug, please submit a new Issue. In your report, please describe the problem as detailed as possible, including:

  • Your operating system and version.
  • Relevant software versions (e.g., Python, Node.js, etc.).
  • Detailed steps to reproduce the bug.
  • The expected behavior and what actually happened.
  • Please attach the log files according to this doc.

Feature Suggestions

If you have an idea for a new feature, please let us know by submitting an Issue. Please describe the feature you would like to see, its use case, and why you think it would be beneficial to the project.

Pull Request Process

  1. Fork the repository: Click the "Fork" button on the top right of this page to fork the project to your own GitHub account.
  2. Clone the repository: Clone your forked repository to your local machine: 
    git clone https://github.com/YOUR_USERNAME/crynux-node.git
cd crynux-node
  3. Set up development environment: Please refer to the README.md to prepare the local development environment, and start the Crynux Node locally.
  4. Commit your changes: 
    git add .
git commit -m "feat: A brief description of your changes"
git push origin main
    We recommend using the Conventional Commits specification for writing commit messages.
  5. Create a Pull Request: After pushing your code, go back to your forked repository page on GitHub and click the "New pull request" or "Compare & pull request" button. Please ensure you are merging your feature branch into the main branch of the original repository.
  6. Describe your PR: In the PR description, please clearly explain the changes you've made and link any relevant issues (e.g., Closes #123).

Community

If you have any questions, feel free to reach out to us through the Crynux Discord:

Crynux Discord

Thank you again for your contribution!