Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
29 lines (16 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

29 lines (16 loc) · 1.13 KB
Raw

Contributing to EduPath AI

First off, thank you for considering contributing to EduPath AI! It's people like you that make open-source such a great community.

Where do I go from here?

If you've noticed a bug or have a feature request, make sure to check our Issues to see if someone else has already created a ticket. If not, go ahead and make one!

Fork & create a branch

If this is something you think you can fix, then fork EduPath AI and create a branch with a descriptive name.

A good branch name would be (where issue #325 is the ticket you're working on):

git checkout -b 325-add-new-riasec-fields

Setup the project locally

Please refer to the Getting Started section in the README.md for detailed instructions on setting up both the Frontend (Next.js) and Backend (Spring Boot).

Make a Pull Request

At this point, you should switch back to your master branch, make sure it's up to date with EduPath AI's master branch. Then, create a pull request.

Please ensure your pull request describes the problem you're trying to solve and the approach you took.

Thank you for contributing!