Skip to content

Latest commit

 

History

History
44 lines (34 loc) · 2.88 KB

CONTRIBUTING.md

File metadata and controls

44 lines (34 loc) · 2.88 KB
Raw

Contributing to Raiden Framework

We welcome contributions to the Raiden Framework! This document provides guidelines and instructions for contributing.

Code of Conduct

Before contributing, please read and follow our Code of Conduct. We expect all contributors to abide by its principles to maintain a welcoming and respectful environment.

How to Contribute

There are many ways to contribute to Raiden Framework:

  • Reporting Bugs: If you find a bug, please open an issue with a clear description, steps to reproduce the problem, and any relevant logs or screenshots.
  • Suggesting Enhancements: Ideas for new features or improvements to existing functionality are always appreciated. Open an issue to suggest an enhancement.
  • Writing Code: Look for open issues, especially those tagged as good first issue or help wanted. These are great starting points for your contributions.
  • Improving Documentation: Enhancements and corrections to our documentation are crucial and always welcome.

Getting Started

  1. Fork the Repository: Start by forking the Raiden Framework repository to your GitHub account.
  2. Clone the Forked Repository: Clone the repository to your local machine to start working on your contributions.
  3. Set Up Your Environment: Follow the setup instructions in the project's README.md to get your development environment ready.
  4. Create a Branch: Make a new branch for your work. Use a clear and descriptive name related to the issue you're addressing.

Making Changes

  • Write clean, maintainable, and efficient code.
  • Ensure your code adheres to the existing coding standards of the project.
  • Add or update tests for the changes you are making.
  • Update documentation to reflect your changes, if necessary.

Submitting a Pull Request

  1. Commit Your Changes: Commit your changes with a clear and descriptive commit message.
  2. Push to Your Fork: Push the changes to your forked repository.
  3. Open a Pull Request: Create a pull request from your fork to the main Raiden Framework repository. Provide a clear description of the problem you're solving and reference any related issues.
  4. Review and Adjust: Maintainers will review your pull request. Be open to feedback and make any necessary adjustments.

Review Process

  • All submissions, including submissions by project members, require review.
  • We aim to respond to pull requests within a few days.
  • Once feedback has been provided, contributors are expected to respond within two weeks. If not, the pull request may be closed for inactivity.

Recognition of Contributors

We value all contributions and provide recognition to our contributors. Significant contributions will be acknowledged in our documentation and release notes.

Questions?

If you have any questions or need assistance, feel free to reach out to the maintainers via Github.

Thank you for contributing to Raiden Framework!