Skip to content

Latest commit

 

History

History
101 lines (58 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

101 lines (58 loc) · 2.82 KB
Raw

Contributing to PyVerse

We welcome contributions to PyVerse! Whether you're fixing bugs, adding new features, improving documentation, or enhancing existing projects, your contributions are highly valued. Please follow the guidelines below to contribute effectively to the project.

How to Contribute

  1. Fork the Repository:

    Click the "Fork" button on the top right of the repository page to create a copy of the repository under your GitHub account.

  2. Clone Your Fork:

    Clone your forked repository to your local machine:

    git clone https://github.com/yourusername/PyVerse.git
cd PyVerse

  3. Create a Branch:

    Create a new branch for your changes:

    git checkout -b my-feature-branch

  4. Make Your Changes:

    Implement your changes, whether it's adding a new project, improving existing features, fixing bugs, or updating documentation.

  5. Commit Your Changes:

    Commit your changes with a descriptive commit message:

    git add .
git commit -m "Add new feature/fix bug/update documentation"

  6. Push Your Branch:

    Push your branch to your forked repository:

    git push origin my-feature-branch

  7. Open a Pull Request:

    Navigate to the original repository on GitHub and open a pull request from your branch. Provide a detailed description of your changes and the reasons behind them.

Guidelines

  • Code Style:

    Adhere to the existing code style of the project. Ensure your code is clean, well-structured, and documented. Follow PEP 8 for Python code style guidelines.

  • Testing:

    Ensure your changes do not break existing functionality. Run the test suite before submitting your pull request:

    pytest

    If you are adding a new feature, include tests to validate your changes.

  • Documentation:

    Update relevant documentation to reflect your changes. This includes README files, project descriptions, and any new features or modifications.

  • Commit Messages:

    Write clear and concise commit messages. Use the imperative mood in the subject line (e.g., "Fix issue" instead of "Fixed issue").

  • Pull Requests:

    • Provide a clear and detailed description of the changes in your pull request.
    • Reference any related issues or discussions.
    • Be responsive to feedback and make adjustments as needed.

Code of Conduct

This project is governed by a Code of Conduct. By participating, you agree to uphold this code and ensure a respectful and inclusive environment. Report any issues to [email protected].

Contact

For questions, suggestions, or general inquiries, please reach out to us at [email protected].

Thank you for contributing to PyVerse!