Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 2.22 KB

CONTRIBUTING.md

File metadata and controls

49 lines (33 loc) · 2.22 KB
Raw

Contributing to FuncProfiler

Thank you for considering contributing to FuncProfiler! Contributions, whether they are bug fixes, new features, or improvements to the documentation, are always welcome. Before contributing, please read the following guidelines to ensure smooth collaboration.

Getting Started

  1. Fork the Repository
    Create a fork of this repository to your GitHub account and clone it locally.

  2. Set Up the Environment
    Ensure you have Python 3.6+ installed. You should also install compatible versions of the necessary dependencies for the project.

  3. Run Tests
    Before making changes, run tests to confirm that everything works.

Tip

We sometimes include testing scripts in our projects for easy testing.

How to Contribute

  1. Report Issues
    Use the GitHub Issues page to report bugs or suggest features. Please include:

    • A clear description of the issue or suggestion.
    • Steps to reproduce (for bugs).

  2. Make Changes

    • Use clear and descriptive commit messages.
    • (Optional) Write tests to show new functionality.
    • Ensure the code is readable. You can learn more about Python code readability here: https://peps.python.org/pep-0008/.

  3. Submit a Pull Request

    • Push your changes to a feature branch in your fork.
    • Submit a pull request with a detailed explanation of what you've changed or added.
    • Ensure your PR passes all automated tests and adheres to the contribution guidelines.

Community Guidelines

To maintain a positive and collaborative community, we ask that all contributors adhere to the following principles:

  1. Be Respectful
    Treat others with respect, regardless of their background or expertise.

  2. Provide Constructive Feedback
    Offer helpful and actionable suggestions during code reviews.

  3. Follow Licensing Requirements
    Ensure that any derivative works comply with the license.

By contributing, you agree to abide by these guidelines and this project's license. Thank you for helping make FuncProfiler better!