This is the repo for the breakbuddy website. BreakBuddy is an initiative to help users choose their next holiday destination in an easy and enjoyable way. Our website provides a fun and easy-to-use interface for users all around to world. Our buddy 🐦 will simply ask users a few questions and then recommend the best possible holiday destination that we have in our database. BreakBuddy is a non-profit organisation and our code is completely open-source ❤️.
- How to contribute as a developer 💻
- How to contribute as a translator 📝
- How to contribute to content 💡
- Give us feedback ❓
This project follows the all-contributors specification. Contributions of any kind are welcome! ❤️
This part of the readme.md is dedicated to code contributions 💻.
- Create a new issue.
- Comment on the issue (if you'd like to be assigned to it) - that way our team can assign the issue to you.
- If you're not sure how, here's how to fork a repo.
If this is your first time forking our repo, this is all you need to do for this step:
$ git clone [email protected]:[your_github_profile]/BreakBuddy.gitIf you've already forked the repo, you'll want to ensure your fork is configured and that it's up to date. This will save you the headache of potential merge conflicts.
$ git remote add upstream https://github.com/BreakBuddy/BreakBuddyTo sync your fork with the latest changes:
$ git checkout main
$ git fetch upstream
$ git merge upstream/main- Create new branch for your changes
$ git checkout -b new_branch_name- Start developing!
$ Add features, fix bugs, etc... - Commit and prepare for pull request (PR). In your PR commit message, reference the issue it resolves (see how to link a commit message to an issue using a keyword).
$ git commit -m "brief description of changes [Fixes #1234]"- Push to your GitHub account
$ git push origin- After your changes are committed to your GitHub fork, submit a pull request (PR) to the
mainbranch of theHursitTarcan/BreakBuddyrepo - In your PR description, reference the issue it resolves (see linking a pull request to an issue using a keyword)
- ex.
Updates out of date content [Fixes #1234]
- ex.
- Confirm your preview deploy looks & functions as expected
- Our team will review your PR
- Acceptable PRs will be approved & merged into the
mainbranch
This project follows the all-contributors specification. Contributions of any kind are welcome! ❤️
This part of the readme.md is dedicated to translation contributions 📝.
- Create a new issue, specify the language that you would like to add.
- Anyone can create a new issue (code contributions are not needed for this).
- Comment on the issue (if you'd like to be assigned to it) - that way our team can assign the issue to you.
- You will be asked to upload a txt file with your translation, this can be done via Discord.
- Our team will review your translation.
- Acceptable translations will be approved & merged into the main branch.
This project follows the all-contributors specification. Contributions of any kind are welcome! ❤️
This part of the readme.md is dedicated to content contributions 💡.
- Create a new issue.
- Anyone can create a new issue (code contributions are not needed for this).
- Specify the new feature you would like to add, (design proposal, content change, add new destinations, etc...)
- Comment on the issue (if you'd like to be assigned to it) - that way our team can assign the issue to you.
- Our team will contact you via the issue.
- Our team will review your content change.
- Acceptable content changes will be approved & merged into the main branch.
This project follows the all-contributors specification. Contributions of any kind are welcome! ❤️
This part of the readme.md is dedicated to feedback contributions ❓.
- Create a new issue, specify your feedback.
- Anyone can create a new issue (code contributions are not needed for this).
- Our team will contact you via the issue.
- Feedback is greatly appreciated.
- Acceptable changes will be approved & merged into the main branch.
- Thank you for your feedback ❤️.