Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (42 loc) · 3.44 KB

CONTRIBUTING.md

File metadata and controls

60 lines (42 loc) · 3.44 KB

Contributing to ByteChain Testnet Alpha

Thank you for your interest in contributing to ByteChain Testnet Alpha! Contributions are welcome and greatly appreciated. By participating, you help improve the project and shape the future of decentralized technology.

How to Contribute

We encourage you to contribute in various ways, including:

  • Bug Reports: Identifying and reporting issues helps us make ByteChain more stable.
  • Feature Requests: Share your ideas for new functionalities or improvements.
  • Code Contributions: Fix bugs, implement new features, or improve existing code.
  • Documentation: Enhance our guides, explanations, and API documentation.
  • Testing: Help test new features and existing functionalities.

Here's the process for code contributions:

  1. Fork the Repository: Start by forking the repository to your own GitHub account.

    git clone https://github.com/ByteChain-Labs/ByteChain-Testnet-Alpha.git

  2. Create a New Branch: Before making any changes, create a new branch for your work. Use a descriptive name like feature/your-feature-name or bugfix/issue-description.

    git checkout -b my-feature-branch

  3. Make Your Changes: Implement your feature, fix a bug, or enhance documentation. Ensure your changes align with the project’s goals and maintain high-quality standards.

    • Style: Please adhere to the existing coding style and conventions within the codebase.
    • Tests: If you're adding new features or fixing bugs, please include relevant tests to ensure your changes work as expected and prevent regressions.

  4. Commit Your Changes: Once your changes are complete, commit them with a descriptive message. A good commit message explains what the change is and why it was made.

    git add .
git commit -m "feat: Add concise description of feature"
# Or for a bug fix:
git commit -m "fix: Resolve issue with transaction processing"

  5. Push Your Changes: Push your changes to your forked repository.

    git push origin my-feature-branch

  6. Open a Pull Request: Go to the ByteChain Testnet Alpha repository and open a pull request from your new branch to the main branch. Provide a clear description of your changes, reference any relevant issues (e.g., "Closes #123"), and explain why your contribution is valuable.

  7. Review and Feedback: Wait for maintainers to review your pull request. Respond promptly to any feedback or requested changes to facilitate the merging process.

  8. Merge: After approval, your changes will be merged into the main branch. Congratulations on your contribution!

Code of Conduct

By contributing, you agree to abide by the Code of Conduct. Ensure all interactions are respectful and constructive. We are committed to fostering an open and welcoming community.

Additional Notes

  • Before Major Features: For larger features or significant changes, please open an issue first to discuss your ideas with the maintainers. This helps ensure alignment with the project roadmap and avoids duplicate work.
  • Documentation & Tests: Always update relevant documentation and add/update tests when making changes.
  • Acknowledgement: All accepted contributions will be acknowledged by the maintainers.

Thank you for contributing to ByteChain Testnet Alpha!