First of all, thanks for considering contributing to Simple-Agent-Core! We welcome all contributions big or small, from code changes to documentation updates.
-
Fork the Repository
- Create your own fork of the repository by clicking the 'Fork' button at the top-right of the main repository page.
-
Clone Your Fork
- Clone your fork locally to begin making changes.
git clone https://github.com/reagent-systems/Simple-Agent-Core
-
Create a Branch for Your Contribution
- It's important to create a feature branch and not work directly in the main branch.
git checkout -b your-feature-branch
-
Make Changes
- Make your code changes or improvements. Ensure that your code follows the project's coding standards and style.
-
Write Tests
- If applicable, write tests to cover any code changes.
-
Commit Changes
- Commit your changes with a descriptive commit message.
git add . git commit -m "Description of changes"
-
Push Changes to GitHub
- Push your changes to your fork on GitHub.
git push origin your-feature-branch
-
Open a Pull Request
- Navigate to the original repository you forked from. You should see a 'Compare & pull request' button. Click it to start your pull request.
-
Review Process
- Your pull request will be reviewed by the maintainers, and you may be asked to make amendments.
-
Celebrate!
- After your pull request is merged, you can celebrate your contribution to open source!
Please note that this project follows a Code of Conduct that is expected to be adhered to across all contributions and interactions in the project.
Feel free to reach out with any questions by opening an issue, or joining discussions in the discussions tab.
Thank you for contributing and making this project better!