From b0b300e213e5c556189a1659629b1f316e2d2c0d Mon Sep 17 00:00:00 2001 From: Adebisi Adeyemi <84504391+adebisi4145@users.noreply.github.com> Date: Thu, 17 Oct 2024 13:26:49 +0100 Subject: [PATCH] Improve CONTRIBUTING.md file (#1307) * put issue label and description in a tabular form * add how to contribute heading * add table of contents * add issue types * add emojis to each of the sub sections * expand issue types and add descriptions in a table format * change "label" to "Issue Label" --------- Co-authored-by: Dhanshree Arora --- CONTRIBUTING.md | 45 ++++++++++++++++++++++++++++++++++----------- 1 file changed, 34 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 87392ed8b..9ac147a88 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,27 +4,50 @@ 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 +## Table of Contents + +- [Code of Conduct 🤝](#code-of-conduct-) +- [Where to Start? 🧭](#where-to-start-🧭) +- [How to Contribute 📜](#how-to-contribute-) +- [Create a new Issue 🚀](#create-a-new-issue-) +- [Contribution Workflow 🔄](#contribution-workflow-) +- [Other Contributing Suggestions 💡](#other-contributing-suggestions-) +- [I still have questions ❓](#i-still-have-questions-) + +## 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](https://github.com/ersilia-os/ersilia/blob/master/CODE_OF_CONDUCT.md). -## Where to Start? +## 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: -* 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 +| 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](https://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github) and [Collaborating with pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests). If you land here during the Outreachy contribution period, please look for the appropriate guidelines in our [documentation](https://ersilia.gitbook.io/ersilia-book/contributors/internships). ## 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! +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 +## Contribution Workflow 🔄 Once you have identified an issue to tackle, follow the next steps: @@ -35,13 +58,13 @@ Once you have identified an issue to tackle, follow the next steps: 5. 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. 6. Look for a new issue to work on! -## Other Contributing Suggestions +## 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 or via our online [form](https://airtable.com/shrmEcwwxpb21TEVw) * Documentation-related enhancements are very welcome, please work on them by opening a new issue -## I still have questions +## I still have questions ❓ If you need some more guidance, open an issue and get support from the community!