Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (31 loc) · 3.06 KB

CONTRIBUTING.md

File metadata and controls

62 lines (31 loc) · 3.06 KB
Raw

Contribution Guidelines

Thank you for your interest in contributing to ChatGPT-Executor! We appreciate your effort and value your contributions. This document provides guidelines to help make the contribution process smooth and effective for everyone involved.

Getting Started

  1. Fork the repository: Start by forking the repository to your own GitHub account. This allows you to make changes to the project without affecting the original repository.

  2. Create a branch: Create a new branch with a descriptive name based on the feature or bugfix you plan to work on. For example, fix-issue-123 or add-new-feature.

  3. Clone the repository: Clone the forked repository to your local machine and set the upstream remote to the original repository.

    git clone https://github.com/improveTheWorld/ChatGPT-Executor.git

    cd ChatGPT-Executor

    git remote add upstream https://github.com/improveTheWorld/ChatGPT-Executor.git

Contributing Code

  1. Sync your fork: Before starting your work, ensure your fork is up-to-date with the original repository.

git fetch upstream git merge upstream/main

  1. Write clean and well-documented code: While working on your changes, make sure to follow the project's coding style and write well-documented code.

  2. Test your changes: Test your changes thoroughly to ensure that you do not introduce new bugs.

  3. Commit your changes: Break your work into small, logical commits with descriptive commit messages. This makes it easier for maintainers to review your changes.

  4. Push your changes: Push your changes to your fork on GitHub.

git push origin

Submitting a Pull Request

  1. Create a Pull Request: Go to the original repository on GitHub, and click the "New Pull Request" button. Choose the branch you worked on and submit the Pull Request.

  2. Describe your changes: In the Pull Request description, provide a clear and concise explanation of the changes you made, referencing any related issues or discussions.

  3. Wait for a review: The maintainers will review your Pull Request and may request changes or ask questions. Please be patient and address any feedback provided.

  4. Make any requested changes: If the maintainers request changes, make the necessary updates and push the changes to your branch.

  5. Celebrate: Once your Pull Request is merged, you've successfully contributed to the project! Thank you for your efforts!

Reporting Issues

If you find a bug or have a suggestion, please open a new issue in the repository. When reporting a bug, provide as much information as possible, including steps to reproduce the problem, your operating system, and any relevant error messages.

Additional Resources

Thank you for contributing to [Your Project Name]! Remember to replace [Your Project Name], , , and with the appropriate information for your project.