We welcome contributions and assistance! If you want to know where to start, check out our GitHub Projects page.
Sometimes we might forget something, so if you want to add a new feature that isn't currently listed in our Projects, that's great! Make sure to open a New Issue, with as much information as possible about the feature you'd like to work on, or needs improvements. Otherwise, feel free to contribute to any open Project!
IMPORTANT: To get started with development, please refer to the Development Wiki.
Since this is a new app being developed, we ask that contributors take a look at the GitHub Projects page for areas that we're looking for help and contributions. If you see an item that is not currently In Progress by somebody else, be sure to tag yourself (@your-username) on the particular Open Issue, to avoid duplicate work.
The GitHub Issues section will also be used to track public bugs. Please ensure your bug description is clear and has sufficient instructions to be able to reproduce the issue:
- A summary and/or background of the bug
- Steps to reproduce the bug
- please be specific
- provide sample code if possible
- What you expect should happen
- What actually happens
- Any additional notes
- why you think this might be happening
- methods you've tried already that didn't work
Please ensure that your commit messages are clear and descriptive. For helpful tips and tricks when writing your commit messages, check out this article.
Remember to use the User Story ID on your commit message, where applicable.
Example - Staff User Story #03:
git commit -m "#S03: Allow staff to edit their profile"
All active development of this project happens on GitHub. We actively welcome your pull requests! For information on how to create a pull request, please refer to this GitHub article.
- Follow the steps for Development. IMPORTANT!
- From your forked repo, the PR should look something like this:
- base repository: Code-Institute-Community/ci-hackathon-app
- base: master
- head repository: your-own-account/forked repo
- compare: your-own-branch
- If you've added code that should be tested, please attempt to add the required tests.
- Make sure you address any known issues/bugs/warnings/errors.
- If you make visual changes, please include tested screenshots.
- If you make any existing code better, please let us know in your PR description.
- If contributing to specific User Stories, please be sure to include the appropriate User Story ID.
- #M01 (Miscellaneous User Story #01)
- #P02 (Participant User Story #02)
- #S03 (Staff User Story #03)
- #A04 (Admin User Story #04)
By contributing to Code Institute, you agree that your contributions will be licensed under the standard MIT License, which can be found in the project root directory.
WE ❤️ CONTRIBUTIONS!
Thank You to our contributors (listed in order of total commits):
 Tim Nelson |
 Stefan Dworschak |
 John Traas |
 Miklos Sarosi |
 Natalija Bujevic |
 Anthony O'Brien |
 Sunny Hebbar |
 Rory Patrick Sheridan |
 Irina Tushina |
 Jim Morel |
 Simen Daehlin |
 Sean Murphy |
 Claire Lally |
 Maripia Kuti |
Alexey Kuzmis |
 Andrew Dempsey |
 Attila Szaloki |
Your Name Here |