Skip to content

Latest commit

 

History

History
55 lines (35 loc) · 2.23 KB

CONTRIBUTING.md

File metadata and controls

55 lines (35 loc) · 2.23 KB
Raw

Certainly! Here's a sample CONTRIBUTING.md file for your open-source project:

Contributing to Pipable

Thank you for your interest in contributing to PipableAI! We welcome contributions from the community to make PipableAI better.

How to Contribute

  1. Fork the Repository: Click on the "Fork" button on the top right corner of this repository's page. This will create a copy of the repository in your own GitHub account.

  2. Clone the Repository: Clone the forked repository to your local machine using the following command:

    git clone https://github.com/PipableAI/pipable-open-source.git

  3. Create a New Branch: Create a new branch for your contribution:

    git checkout -b feature-name

  4. Make Changes: Make your changes to the codebase. Ensure your changes follow the coding guidelines of the project.

  5. Commit Changes: Commit your changes with a descriptive commit message:

    git commit -m "Description of your changes"

  6. Push Changes: Push your changes to your forked repository:

    git push origin feature-name

  7. Create a Pull Request (PR): Go to the Pull Requests section of the original repository and click on "New Pull Request". Provide a descriptive title and explain your changes in the PR description. Click "Create Pull Request" to submit your contribution.

Coding Guidelines

  • Follow the PEP 8 style guide for Python code.
  • Ensure meaningful variable and function names for clarity.
  • Write clear and concise comments to explain your code logic.
  • Include unit tests for new functionality or bug fixes.

Issue Reporting

If you encounter any issues or have suggestions for improvements, please open an issue on the issue tracker. Provide detailed information about the problem, steps to reproduce it, and your environment.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.

Thank you for your contribution to Pipable! 🚀