Skip to content

Create CONTRIBUTING.md #25

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.

Sign up for GitHub

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

Open
0Armaan025 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Create CONTRIBUTING.md #25

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
53 changes: 53 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# 😎 Welcome to AgentTuning Contribution Guide! 😎

👋 Thank you for considering contributing to AgentTuning! We appreciate your help in making this project even better.

🌟 Before you get started, here's a few things you should know:

## 📝 How to Contribute

1. **Fork the Repository:** Start by forking the [AgentTuning repository](https://github.com/THUDM/AgentTuning) to your own GitHub account.

2. **Clone the Repository:** Now, clone your forked repository to your local machine:

```bash
git clone https://github.com/YourUsername/AgentTuning.git
```

3. **Create a Branch:** Create a new branch for your contribution:

```bash
git checkout -b your-feature
```

4. **Make Changes:** Add your amazing contributions to the project. Don't forget to keep your code clean and well-documented!

5. **Test Your Code:** Ensure that your code works properly and doesn't introduce new issues.

6. **Commit Your Changes:** Commit your changes with a descriptive message:

```bash
git commit -m "Add your descriptive commit message here"
```

7. **Push to Your Fork:** Push your branch to your forked repository:

```bash
git push origin your-feature
```

8. **Create a Pull Request:** Open a pull request from your branch to the main AgentTuning repository. Give it a meaningful title and describe your changes in detail.

9. **Review and Collaborate:** Participate in discussions and address feedback if necessary. We encourage collaboration to ensure the best possible contributions!

## 🔍 Issues and Bug Reports

If you find a bug or want to suggest an improvement, please open an issue on our [issue tracker](https://github.com/THUDM/AgentTuning/issues). Make sure to provide a clear and detailed description of the issue.

## 🎉 Thanks for Your Contributions!

Your contributions are what make AgentTuning great! We truly appreciate your time and effort in helping us improve this project.

🚀 Let's build amazing things together! 🚀

If you have any questions or need assistance, feel free to reach out to us. Happy coding! 😄