Skip to content

Latest commit

 

History

History
46 lines (34 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

46 lines (34 loc) · 2.28 KB

Contributing to rusteron

Thank you for considering contributing to rusteron! Contributions are an integral part of improving this project and making it more useful for everyone. Below are some simple guidelines to help you get started.

How Can You Contribute?

1. Reporting Issues

If you find a bug, have a question, or want to request a new feature, please open an issue in our GitHub Issues page. When reporting a bug, be as specific as possible about how to reproduce the issue, including any code snippets or error messages that may help.

2. Submitting Pull Requests

If you'd like to fix a bug or add a feature yourself, follow these steps:

  1. Fork the Repository: Create a personal copy of the repository by clicking the "Fork" button.
  2. Clone the Fork: Clone your forked repository to your local machine. 
    git clone https://github.com/your-username/rusteron.git
  3. Create a Branch: Create a new branch for your work. 
    git checkout -b feature-name
  4. Make Changes: Add your improvements or bug fixes.
  5. Test Your Changes: Ensure that your changes do not break existing functionality by running tests.
  6. Commit and Push: Commit your changes and push them to your fork. 
    git commit -m "Add feature or fix bug"
git push origin feature-name
  7. Open a Pull Request: Submit a pull request to the original repository for review.

3. Improving Documentation

Good documentation helps everyone. If you notice missing information or something that could be explained better, feel free to submit a pull request to update the documentation.

Guidelines

  • Code Style: Follow Rust's conventions for code formatting. Run cargo fmt before committing.
  • Testing: Ensure new features and bug fixes are covered by tests. Use cargo test to run all tests.
  • Commit Messages: Use clear and concise commit messages. For example: "Fix buffer allocation bug in Aeron context".
  • License: By contributing, you agree that your contributions will be licensed under both the MIT and Apache-2.0 licenses.

Contact

If you have any questions or need further assistance, feel free to reach out by opening an issue on GitHub.

Thank you for helping to improve rusteron!