Contributing

Thank you for contributing to Ersilia's mission and vision! ⭐

Ersilia is an open project and everyone is welcome to contribute to it. Please read the following sections to make sure your contribution aligns with Ersilia's guidelines and is an enjoyable experience for all.

Code of Conduct 🤝

We aspire to create a welcoming and safe environment for collaboration on this project and ask all contributors to do the same. Help us keep Ersilia open and inclusive. Please read and follow our Code of Conduct.

Where to Start? 🧭

The best place to start is by checking our issue tracker. Our issues have the following labels to guide contributors in their work:

Issue Label	Description
Good first issue	A small task suitable to start your contributions to the project
Help wanted	An issue currently not assigned to anyone
Bug	Fix something that is not working
Enhancement	Add a new feature
Documentation	Issues related to the project's documentation

How to Contribute 📜

If this is the first time contributing to an Open Source project, read a bit about How to Contribute to An Open Source Project on Github and Collaborating with pull requests. If you land here during the Outreachy contribution period, please look for the appropriate guidelines in our documentation.

Create a new Issue 🚀

The issue tracking avoids duplications and prevents different contributors working on the same feature separately, so please make sure to create a new issue with the appropriate labels before jumping on coding! You can create the following issue types:

Issue Type	Description
🦠 Model Request	Request to add a new model to the hub
🐛 Bug Report	Report something that is not working as expected
📑 Feature Request	Suggest a new feature or enhancement
🐕 Batch	Create a new Batch
🐅 Epic	Create a new Epic
🐈 Task	Create a new Task

Contribution Workflow 🔄

Once you have identified an issue to tackle, follow the next steps:

Fork the repository
Make changes in your fork (or in a branch of your fork)
Create a Pull Request (PR) with a description of the changes made. A good description really helps the community managers. Link the issue the PR is related to as well.
PR's have automated tests. If the tests fail, please make the necessary changes. Ersilia maintainers will only work on PRs that pass the tests.
Once the PR has been merged, delete your fork of the repository. Our Git-LFS quota also takes into account forks, so having unused forks sitting around is eating up our space in Git LFS. Thanks for taking care of the community.
Look for a new issue to work on!

Other Contributing Suggestions 💡

Support already existing contributors with comments on the issues they might be tackling
Create new issues for bug reports or feature enhancements using the appropriate templates (even if the issue is out of scope for you, it might be a good job for another contributor)
Suggest new models to the Ersilia Model Hub using an issue
Documentation-related enhancements are very welcome, please work on them by opening a new issue

I still have questions ❓

If you need some more guidance, open an issue and get support from the community!

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!