Skip to content

Latest commit

 

History

History
75 lines (51 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

75 lines (51 loc) · 2.16 KB

Contributing to python_snippets

Thank you for your interest in contributing to python_snippets! Your contributions are highly appreciated. Please follow these guidelines to help us improve and maintain the project.

How to Contribute

  1. Fork the Repository

    Fork the repository to your GitHub account by clicking the "Fork" button on the top right of the repository page.

  2. Clone the Repository

    Clone the forked repository to your local machine:

    git clone https://github.com/your-username/python_snippets.git
cd python_snippets

  3. Create a Branch

    Create a new branch for your work

    Copy code
git checkout -b feature/your-feature-name

  4. Make Changes

    Make your changes or additions. Ensure your code follows the project's coding style and passes all tests.

  5. Commit Your Changes

    Commit your changes with a clear and descriptive commit message:

    Copy code
git add .
git commit -m "Add feature: description of your feature"

  6. Push to Your Fork

    Push your changes to your forked repository:

    Copy code
git push origin feature/your-feature-name

  7. Create a Pull Request

    Create a pull request to the main branch of the original repository. Provide a clear and descriptive title and description for your pull request.

Code of Conduct

Please note that this project adheres to a Code of Conduct. By participating, you are expected to uphold this code.

Style Guide

  • Follow PEP 8 for Python code style.
  • Write clear and concise commit messages.
  • Write meaningful and descriptive comments in your code.
  • Ensure your code is well-documented.

Running Tests

Make sure all tests pass before submitting your pull request. You can run the tests using:

pytest

Reporting Issues

If you find a bug or have a feature request, please create an issue on GitHub. Provide as much detail as possible to help us understand and address the issue.

Acknowledgments

Thank you for your contributions and for helping to improve python_snippets!

This CONTRIBUTING.md file is based on GitHub's contributing guidelines.