🚫 Note: All lines that start with 🚫 are instructions and should be deleted before this is posted to your portfolio. This is intended to be a guideline. Feel free to add your own flare to it.
🚫 The numbers 1️⃣ through 5️⃣ next to each item represent the week that part of the docs needs to be comepleted by. Make sure to delete the numbers by the end of Labs.
🚫 Each student has a required minimum number of meaningful PRs each week per the rubric. Contributing to docs does NOT count as a PR to meet your weekly requirements.
You can find the project at [🚫URL NAME GOES HERE](🚫copy and paste URL here).
🚫Add contributor info below, make sure add images and edit the social links for each member. Add to or delete these place-holders as needed
| Student 1 | Student 2 | Student 3 | Student 4 | Student 5 |
|---|---|---|---|---|
 |
 |
|
|
|
 |
|
|
|
|
🚫 5️⃣ Optional examples of using images with links for your tech stack, make sure to change these to fit your project
](netlify link goes in these parenthesis)
🚫 more info on using badges here
1️⃣ Trello Board
1️⃣ Product Canvas
🚫 Replace lorem ipsum with a description of your project
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
🚫 delete if front end is not applicable to your project
1️⃣ [Deployed Front End](🚫add link to deployed app here)
🚫 List all of the languages, frameworks, services, etc used here.
🚫 Describe your models here
- Explanatory Variable 1
- Explanatory Variable 2
- Explanatory Variable 3
- Explanatory Variable 4
- Explanatory Variable 5
🚫 Add to or delete souce links as needed for your project
- [Source 1] (🚫add link to python notebook here)
- [Source 2] (🚫add link to python notebook here)
- [Source 3] (🚫add link to python notebook here)
- [Source 4] (🚫add link to python notebook here)
- [Source 5] (🚫add link to python notebook here)
🚫 Add to or delete python notebook links as needed for your project
[Python Notebook 1](🚫add link to python notebook here)
[Python Notebook 2](🚫add link to python notebook here)
[Python Notebook 3](🚫add link to python notebook here)
🚫 List directions on how to connect to the API here
🚫 List directions on how to connect to the API here
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please note we have a code of conduct. Please follow it in all your interactions with the project.
If you are having an issue with the existing project code, please submit a bug report under the following guidelines:
- Check first to see if your issue has already been reported.
- Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
- Create a live example of the problem.
- Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.
We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.
If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.
Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
- Ensure that your code conforms to our existing code conventions and test coverage.
- Include the relevant issue number, if applicable.
- 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.
These contribution guidelines have been adapted from this good-Contributing.md-template.
See [Backend Documentation](link to your backend readme here) for details on the backend of our project.
See [Front End Documentation](link to your front end readme here) for details on the front end of our project.