When contributing to this repository, please first discuss the change you wish to make via issue, email, slack, or any other method with the contributes of this repository, or Code for Baltimore, before making a change.
Please note we have a CODE OF CONDUCT, please follow it in all your interactions with the project.
In this section you should provide a semi-detailed overview of your project. This overview should include a statement of the problem you're looking to solve, maybe some bullet points, and a statement defining the solution.
This should be a list of bullets of related features you are not planning to add to the project. This should be adjusted based on the maturity of the product.
As with the Non Goals this should be a bulleted list of features you will include in your product. This list can be adjusted based on the maturity of the product.
Provide an esitmate of when work will be completed, or a link to any kanban boards you may have.
Provide a bulleted list of your applicable tech stack. Below is the standard sentence to link to the Best_Practices doc. You can also link to the Tech_Spec.
Please update the Tech Spec with a full breakdown of the project and workflows then link it here.
Please update the Best Practices with code standards, git standards, and other guidance for writing clean and well documented code then link it here.
- Ensure you thoroughly fill out the pull request form presented when submitting the request. This includes listing what work was done, what issues are resolved by that work, what tests have been added, how to perform other tests or run the code, and other potentially relevant notes.
- Update the README.md with details of changes to the application, this includes new environment variables, exposed ports, useful file locations and/or container parameters.
- If you are on the project team you may merge the Pull Request in once you have the sign-off of one other developer, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
The best ways to get in touch with us is via Slack. An active Slack link can be found on our website:
You can also reach out to the tech lead Jason Anton via email at jason@codeforbaltimore.org.
Provide any relevant links here.