Contribution Guidelines
We welcome contributions to this repository! Whether you want to add new resources, fix typos, or improve the documentation, your help is appreciated.
Feel free to open an issue with your suggestions, or even better, submit a pull request following the steps below.
How to Contribute
-
Fork the Repository: Start by forking this repository to your own GitHub account.
-
Clone Your Fork: Clone your forked repository to your local machine.
git clone https://github.com/your-username/chem-ai-resources.git -
Create a New Branch: Create a new branch for your changes.
git checkout -b my-feature-branch -
Make Your Changes: Add new resources or make changes to existing files.
- To add a new resource, edit the
data/resources.ymlfile and follow the existing format.
- To add a new resource, edit the
-
Commit Your Changes: Commit your changes with a descriptive message.
git add . git commit -m "Add new resource on XYZ" -
Push to Your Fork: Push your changes to your forked repository.
git push origin my-feature-branch -
Create a Pull Request: Go to the original repository and create a pull request from your forked repository.