diff --git a/README.md b/README.md index ab3866b..4fb0cab 100644 --- a/README.md +++ b/README.md @@ -21,3 +21,33 @@ The original dataset was downloaded from the [RCSB Protein Data Bank (PDB)](http ## Inspiration The Protein Data Bank has been instrumental in advancing research within the life science community. It has facilitated the study of various diseases and has contributed to the development of new drugs and solutions aimed at improving human survival. + +# Contributing Guidelines + +## Getting Started + +1. Fork the repository on GitHub. +2. Clone your forked repository to your local machine. +3. Create a new branch for your modifications. +4. Make your changes and additions in the new branch. + +## Making Changes + +1. Before starting any work, create an issue to discuss the proposed changes. +2. Ensure that your changes align with the goals and scope of the dataset. +3. Maintain a clear and concise commit history for better readability. +4. Test your modifications thoroughly to ensure they do not introduce any issues. + +## Submitting Changes + +1. Push your changes to your forked repository. +2. Submit a pull request (PR) from your branch to the main repository. +3. Provide a clear and descriptive title for your PR. If you are considering to submit an entire ipynb file include your username and model implemented in the tiltle in the following format: _.ipynb +4. Include relevant information and context in the PR description. +5. Be responsive to any feedback or questions during the review process. + +## Further Assistance + +If you have any questions or need assistance, feel free to reach out by creating an issue or contacting the project maintainers. + +Thank you for your contribution! Together, we can enhance the Protein Data Set and advance research in the life science community.