LLM/DocsGPT
1
0
Fork 0
mirror of https://github.com/arc53/DocsGPT.git synced 2025-11-29 08:33:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

neha3423

Browse Source
This commit is contained in:
neha3423
2023-10-22 10:54:02 +05:30
parent 641e75b8a8
commit 960365a063
1 changed files with 22 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
CONTRIBUTING.md
View File

@@ -57,42 +57,55 @@ Here's a step-by-step guide on how to contribute to DocsGPT:
1. **Fork the Repository:** 1. **Fork the Repository:**
- Click the "Fork" button at the top-right of this repository to create your fork. - Click the "Fork" button at the top-right of this repository to create your fork.
2. **Create and Switch to a New Branch:** 2. **Clone the Forked Repository:**
- Clone the repository using:
''' shell
git clone https://github.com/<your-github-username>/DocsGPT.git
'''
3. **Keep your in Sync:**
- Before you make any changes, make sure that your fork is in sync to avoid merge conflicts.
'''shell
git remote add upstream https://github.com/arc53/DocsGPT.git
git pull upstream master
'''
4. **Create and Switch to a New Branch:**
- Create a new branch for your contribution using: - Create a new branch for your contribution using:
```shell ```shell
git checkout -b your-branch-name git checkout -b your-branch-name
``` ```
3. **Make Changes:** 5. **Make Changes:**
- Make the required changes in your branch. - Make the required changes in your branch.
4. **Add Changes to the Staging Area:** 6. **Add Changes to the Staging Area:**
- Add your changes to the staging area using: - Add your changes to the staging area using:
```shell ```shell
git add . git add .
``` ```
5. **Commit Your Changes:** 7. **Commit Your Changes:**
- Commit your changes with a descriptive commit message using: - Commit your changes with a descriptive commit message using:
```shell ```shell
git commit -m "Your descriptive commit message" git commit -m "Your descriptive commit message"
``` ```
6. **Push Your Changes to the Remote Repository:** 8. **Push Your Changes to the Remote Repository:**
- Push your branch with changes to your fork on GitHub using: - Push your branch with changes to your fork on GitHub using:
```shell ```shell
git push origin your-branch-name git push origin your-branch-name
``` ```
7. **Submit a Pull Request (PR):** 9. **Submit a Pull Request (PR):**
- Create a Pull Request from your branch to the main repository. Make sure to include a detailed description of your changes and reference any related issues. - Create a Pull Request from your branch to the main repository. Make sure to include a detailed description of your changes and reference any related issues.
8. **Collaborate:** 10. **Collaborate:**
- Be responsive to comments and feedback on your PR. - Be responsive to comments and feedback on your PR.
- Make necessary updates as suggested. - Make necessary updates as suggested.
- Once your PR is approved, it will be merged into the main repository. - Once your PR is approved, it will be merged into the main repository.
9. **Testing:** 11. **Testing:**
- Before submitting a Pull Request, ensure your code passes all unit tests. - Before submitting a Pull Request, ensure your code passes all unit tests.
- To run unit tests from the root of the repository, execute: - To run unit tests from the root of the repository, execute:
```shell ```shell
@@ -101,7 +114,7 @@ Here's a step-by-step guide on how to contribute to DocsGPT:
*Note: You should run the unit test only after making the changes to the backend code.* *Note: You should run the unit test only after making the changes to the backend code.*
10. **Questions and Collaboration:** 12. **Questions and Collaboration:**
- Feel free to join our Discord. We're very friendly and welcoming to new contributors, so don't hesitate to reach out. - Feel free to join our Discord. We're very friendly and welcoming to new contributors, so don't hesitate to reach out.
Thank you for considering contributing to DocsGPT! 🙏 Thank you for considering contributing to DocsGPT! 🙏