Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
130 lines (84 loc) · 4.65 KB

CONTRIBUTING.md

File metadata and controls

130 lines (84 loc) · 4.65 KB

Contributing to RPC Labs

First of all, thank you for taking the time to contribute to RPC Labs! 🚀 Your efforts help us provide trusted and relevant financial tools for the open-source community. We welcome contributions from everyone, regardless of your level of coding experience.

This guide outlines the ways you can contribute and the steps to follow when making a contribution.

🌟 Ways to Contribute

You can contribute in several ways:

Contribution Type Description
New Features Propose and add new functionality to enhance existing tools or create new ones.
Bug Reports Identify and report bugs or issues in the tools or documentation.
Documentation Updates Improve clarity, fix errors, or expand documentation to better serve the community.
Feedback and Ideas Share suggestions for improvements, new tools, or features you'd like to see in future releases.

If you're unsure about what to contribute, feel free to browse the Issues tab for ideas or discussions.

🛠️ Contribution Workflow

Non-Technical Contributions

If you’re not familiar with Git or coding, you can still contribute by:

  • Reporting bugs or issues via the Issues tab.
  • Starting a discussion in the Discussions tab to share feedback or propose ideas.

Technical Contributions

For those with Git experience, follow these steps to contribute:

  1. Fork the Repository:

  2. Clone the Fork Locally:

    git clone https://github.com/YOUR_USERNAME/REPO_NAME.git
cd REPO_NAME

  3. Create a New Branch:

    git checkout -b feature/your-feature-name

  4. Make Your Changes:

    • Follow any code style or documentation guidelines.
    • Test your changes locally if applicable.

  5. Commit Your Changes:

    git add .
git commit -m "Descriptive message about your changes"

  6. Push to Your Fork:

    git push origin feature/your-feature-name

  7. Submit a Pull Request (PR):

    • Go to your forked repository on GitHub.
    • Click on "New Pull Request" and follow the prompts.
    • Add a clear description of your changes and their purpose.

⭐ Show Your Support

Help us grow the RPC Labs community! If you find our repositories valuable, please star them on GitHub to show your support and stay updated on new developments.

📝 Guidelines

  • Code Quality:

    • Follow consistent coding styles (e.g., PEP 8 for Python).
    • Include comments and documentation for better understanding.

  • Testing:

    • Test your changes thoroughly.
    • Provide test cases or examples if applicable.

  • Documentation:

    • Use clear and concise language.
    • Maintain formatting consistency.

💬 Community Standards

Our community follows the Code of Conduct. Please ensure your interactions are respectful and constructive.

🙌 Acknowledgments

We value every contribution! Contributors will be credited in:

  • Release notes for significant updates.
  • The project’s acknowledgments section.

📜 Legal Compliance

By contributing to RPC Labs repositories, you affirm that:

  • Your contributions do not violate any applicable laws, regulations, or third-party rights.
  • You have the legal right to license your contributions under the repository's open-source license.

📜 Legal Notices

  • License: Unless written otherwise, all contributions are licensed under the MIT License.
  • Disclaimer: All code is provided "as-is" without warranties. Users are responsible for security risks and compliance with applicable laws. See DISCLAIMER.md for full details.

Thank you for helping us improve RPC Labs! 🚀

For any questions, feel free to start a discussion or email us at info@cfainstitute.org.

Thank you for helping us improve RPC Labs!