Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (32 loc) · 1.98 KB

CONTRIBUTING.md

File metadata and controls

49 lines (32 loc) · 1.98 KB
Raw

Contributing to RCF Protocol

First off, thank you for considering contributing to the RCF (Restricted Correlation Framework) Protocol! It's people like you that make this project better.

How to Contribute

There are many ways to contribute to the project:

  • Reporting Bugs: Submit detailed bug reports including reproduction steps.
  • Suggesting Enhancements: Propose new features or improvements.
  • Writing Code: Submit pull requests for bug fixes or new features.
  • Improving Documentation: Fix typos, add examples, or write tutorials.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally.
  3. Create a new branch for your feature or bugfix (e.g., git checkout -b feature/awesome-new-feature).

Development Guidelines

SDK Contributions

The RCF Protocol contains multiple SDKs (e.g., TypeScript, Python). When contributing to a specific SDK:

  • TypeScript: Ensure your code follows the established formatting conventions. Run any available linters and tests.
  • Python: Ensure your code is PEP 8 compliant and passes all tests.

Code Style

  • Keep your code clean, readable, and well-documented.
  • Write meaningful commit messages.
  • Add tests for new features and bug fixes to ensure stability.

Pull Request Process

  1. Ensure your code builds cleanly and all tests pass.
  2. Push your branch to your fork on GitHub.
  3. Open a Pull Request (PR) against the main branch of the upstream repository.
  4. Provide a clear and detailed description of your changes in the PR. Link any relevant issues (e.g., Fixes #123).
  5. Await review from the maintainers. We may suggest some changes before merging.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please report any unacceptable behavior to aladdin@aliyev.site.

Questions?

If you have any questions or need help, feel free to open an issue or reach out to the project maintainers.

Thank you for contributing!