Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
31 lines (20 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

31 lines (20 loc) · 1.63 KB
Raw

Contributing to MedTrack

First off, thank you for considering contributing to MedTrack! It's people like you that make MedTrack such a great tool. 🚀

We welcome contributions from the community, especially during the Elite Summer of Code (ECSoc)!

How to Contribute

Before starting work on an issue:

  1. ⭐ Star this repository to show your support!
  2. 🍴 Fork the repository to your own GitHub account.
  3. 💬 Join our Discord community for discussions and issue assignments: https://discord.gg/F7TUpgPzJ
  4. 📌 Comment on the issue you'd like to work on and wait to be assigned by an admin.
  5. 🌿 Create a new branch for your changes (git checkout -b feature/YourFeatureName).
  6. 💻 Write your code and ensure it runs locally.
  7. ✅ Submit a Pull Request with the required ECSoc26 label.

⚠️ IMPORTANT: Please do not start working on an issue until it has been officially assigned to you by an admin.

Development Setup

See the README.md for instructions on how to set up the React Frontend and Spring Boot Backend locally.

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  3. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Thank you for your contribution! ❤️