Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Contributing.md file #250

Merged
merged 1 commit into from
Apr 6, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@

To contribute to this GitHub project, you can follow these steps:

1. Fork the repository you want to contribute to by clicking the "Fork" button on the project page.

2. Clone the repository to your local machine using the following command:

```
git clone https://github.com/Torantulino/Auto-GPT
```
3. Create a new branch for your changes using the following command:

```
git checkout -b "branch-name"
```
4. Make your changes to the code or documentation.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
4. Make your changes to the code or documentation.
4. Make your changes to the code or documentation.
**Ensure each commit is small and addresses a SINGLE issue.** PRs with commits that sneak in extra tweaks will likely be rejected.

- Example: Improve User Interface or Add Documentation.

5. Add the changes to the staging area using the following command:
```
git add .
```

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Or, if using Git in VS-Code, select specific lines of code and commit them.

6. Commit the changes with a meaningful commit message using the following command:
```
git commit -m "your commit message"
```
7. Push the changes to your forked repository using the following command:
```
git push origin branch-name
```
8. Go to the GitHub website and navigate to your forked repository.

9. Click the "New pull request" button.

10. Select the branch you just pushed to and the branch you want to merge into on the original repository.

11. Add a description of your changes and click the "Create pull request" button.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Be as clear, descriptive and specific as possible.
- Use markdown formatting for a clear and well written post.

12. Wait for the project maintainer to review your changes and provide feedback.

13. Make any necessary changes based on feedback and repeat steps 5-12 until your changes are accepted and merged into the main project.

14. Once your changes are merged, you can update your forked repository and local copy of the repository with the following commands:

```
git fetch upstream
git checkout master
git merge upstream/master
```
Finally, delete the branch you created with the following command:
```
git branch -d branch-name
```
That's it you made it 🐣⭐⭐