Skip to content

Latest commit

 

History

History
58 lines (40 loc) · 2.38 KB

CONTRIBUTING.md

File metadata and controls

58 lines (40 loc) · 2.38 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to aplustools! We welcome contributions from everyone. Below are some guidelines to help you get started.

Getting Started

  1. Fork the Repository:

    • Click on the 'Fork' button at the top right corner of the repository page to create a copy of the repository in your GitHub account.

  2. Clone the Repository:

    • Clone your forked repository to your local machine using git clone https://github.com/your-username/aplustools.git

  3. Set Up a Virtual Environment:

    • It's a good practice to create a virtual environment for the project. You can create a virtual environment using python -m venv env.
    • Activate the virtual environment:
      • On Windows: .\env\Scripts\activate
      • On Unix or MacOS: source env/bin/activate

  4. Install Development Dependencies:

    • Install the development dependencies using pip install -r requirements-dev.txt

Making Changes

  1. Create a New Branch:

    • Create a new branch for your changes using git checkout -b branch-name.

  2. Make Your Changes:

    • Make your changes and test them thoroughly.
    • Ensure your changes do not break any existing functionality.
    • Ensure your code follows the PEP 8 coding standard.

  3. Commit Your Changes:

    • Commit your changes with a meaningful commit message.
    • Push your changes to your forked repository on GitHub.

Submitting a Pull Request

  1. Creating a Pull Request:

    • Go to the repository page on GitHub and click on the 'New Pull Request' button.
    • Select your fork and branch from the dropdown menus and click 'Create Pull Request'.

  2. Describing Your Changes:

    • In the pull request description, explain your changes and how they improve the project.
    • Link any relevant issues or discussions.

  3. Code Review:

    • Maintainers will review your pull request and provide feedback.
    • Address any requested changes and update your pull request as needed.

  4. Merge:

    • Once approved, your pull request will be merged into the main branch.

Community

  • Feel free to open an issue or create a pull request, regardless of your experience level.
  • Join our community chat to discuss the project with other contributors.

Thank you for contributing to aplustools!