Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (33 loc) · 2.15 KB

CONTRIBUTING.md

File metadata and controls

51 lines (33 loc) · 2.15 KB

Contributing to auto_scripts

First off, thank you for considering contributing to auto_scripts! Your help is greatly appreciated.

How to Contribute

Reporting Bugs

If you find a bug, please report it by opening an issue in the Issues section. Provide as much detail as possible, including steps to reproduce the bug, your operating system, and any relevant logs or screenshots.

Suggesting Features

If you have an idea for a new feature or an enhancement to an existing feature, please open an issue in the Issues section. Describe the feature in detail, including its benefits and any potential drawbacks.

Contributing Code

  1. Fork the Repository: Click the "Fork" button at the top right corner of the repository page to create your own copy of the repository.

  2. Clone Your Fork: Clone your fork to your local machine using the following command:

    git clone https://github.com/your-username/auto_scripts.git

  3. Create a Branch: Create a new branch for your work:

    git checkout -b my-feature-branch

  4. Make Your Changes: Make your changes to the codebase. Ensure your code follows the project's coding standards and conventions.

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

    git commit -m "Description of my changes"

  6. Push to Your Fork: Push your changes to your forked repository:

    git push origin my-feature-branch

  7. Submit a Pull Request: Go to the original repository and open a pull request. Provide a clear and detailed description of your changes and the problem they solve.

Code Review Process

All submissions, including those by project members, require review. We use GitHub's pull request system for this purpose. Ensure your submission adheres to the repository's coding standards and passes all tests.

Coding Standards

  • Follow the existing coding style of the project.
  • Write clear and concise commit messages.
  • Include comments where necessary, especially for complex or non-obvious code.