Thank you for considering contributing to DeepDrugDomain! We value the input of developers, researchers, and enthusiasts in the community, and we're excited to see how you can help improve this toolkit for drug-target interaction prediction and drug-target affinity prediction.
There are many ways to contribute to DeepDrugDomain, from writing code and fixing bugs to improving documentation or designing new features. Here's how to get started:
- A clear and descriptive title.
- A detailed description of the issue or feature request.
- Any relevant code snippets or error messages.
- Steps to reproduce the issue (for bugs).
- Fork the Repository: Fork the DeepDrugDomain repository on GitHub to your personal account.
- Clone Your Fork: Clone your fork to your local machine.
git clone https://github.com/yazdanimehdi/deepdrugdomain.git cd deepdrugdomain - Create a New Branch: Create a new branch for your feature or bug fix.
git checkout -b feature/my-new-feature
- Make Your Changes: Write code, fix bugs, or add tests in your branch.
- Test Your Changes: Ensure your changes pass all tests and adhere to the coding standards.
- Commit Your Changes: Commit your changes with a clear and descriptive commit message.
git commit -m "Add new feature for..." - Push to GitHub: Push your changes to your GitHub fork.
git push origin feature/my-new-feature
- Open a Pull Request: Go to the DeepDrugDomain repository on GitHub and open a new pull request from your feature branch.
Create Meaningful Examples: Develop clear and concise examples that demonstrate the usage and benefits of new features or improvements. Document the Examples: Provide thorough documentation for each example to ensure they are easily understandable. Improving Documentation
Clarity and Completeness: Ensure documentation is clear, complete, and easy to follow. Consistency: Maintain a consistent style and tone throughout the documentation. Adding Models to the Package
Good examples for any package is crucial. If you would like to create usage examples for this package, simply follow the same process as contributing code. Your contributions to examples are equally appreciated.
If you have developed a model that you think would benefit DeepDrugDomain, we encourage you to contribute. Documentation for Models: Provide comprehensive documentation for your model, including its purpose, usage, and any limitations. Testing and Validation: Ensure your model is well-tested and validated for performance and accuracy. Submission Process: Follow the same process as contributing code to submit your model.
Good documentation is crucial for any project. If you would like to improve the documentation, simply follow the same process as contributing code. Your contributions to documentation are equally appreciated.
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
If you have questions about contributing, feel free to ask them in the issue tracker or by contacting the maintainers at yazdani@ucf.edu.
Thank you for your contributions to DeepDrugDomain!