How to Contribute

This project is undertaken by the NIAEFEUP student branch at FEUP. If you're a member of NIAEFEUP, please read this guide carefully and reach out to the current project manager. We have a list of issues but usually have priorities aligned with the team. However, if you're not a member but wish to contribute to the website, you can always assist by forking the repository and submitting a pull request that addresses a specific issue.

Contents

• Steps to Contribute
• Common Git Commands

Steps to Contribute

• Check our list of issues and choose one that you find interesting.
• Inform the project manager of your choice (optionally, you can ask them for issue suggestions).
• Create a new branch from develop. We follow a Gitflow approach and our naming follows the pattern feature/<new-feature>, fix/<bug-explanation> and so on.
• While we don't have a strict convention for commit messages, please ensure your commit history remains readable and concise.
• Once you have made progress, push your branch and open a Pull Request as a Draft. When you're finished, mark it as Ready for Review.
• Don't forget to include tests and documentation (API or wiki) for your new feature!
• Request a code review from your peers. Currently, we require a minimum of 2 approvals to merge a PR. This practice is vital to maintain a high-quality codebase and to learn from each other's contributions.
• If needed, update your branching by rebasing/merging from develop.
• Congratulations, you are now ready to merge your changes! 🚀

Common Git Commands

git switch -c feature/new-cool-thing

git add -A
git commit -m "Added this really cool thing"

git push -u origin feature/new-cool-thing

git rebase develop // update your branch
git rebase -i HEAD~5 // change your last 5 commits (rewrite history)
git commit --amend // change the last commit
git push --force-with-lease // push after rebasing or amending a commit (be careful)