diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 34c1bd69..dcf589f8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,11 +1,11 @@ -### Thank you for your interest in making the Lot Occupancy System better +# Thank you for your interest in making the Lot Occupancy System better Together, we can build high quality software that meets the needs of municipalities, while remaining open and budget conscious. **Thank you for taking the time to read the contributing guidelines.** -### All contributions are welcome +## All contributions are welcome Being a very small team, contributions are greatly appreciated. How can you contribute? @@ -14,20 +14,20 @@ Being a very small team, contributions are greatly appreciated. How can you con - Submit bug reports (or fix them!) - Request new features (or build them!) -### Please Read the Code of Conduct +## Please Read the Code of Conduct The [Code of Conduct](CODE_OF_CONDUCT.md) document describes how we should act when working together. Be nice! :smile: -### How to report a bug or suggest an enhancement +## How to report a bug or suggest an enhancement **If you find a security vulnerability, do NOT open an issue. Email -[mailto:corporateapps@cityssm.on.ca](corporateapps@cityssm.on.ca) instead.** + instead.** For all other bug reports, feature requests, or enhancements, open an issue and use the closest template. -### Thanks Again +## Thanks Again We are a very small team with big aspirations and limited resources. Thank you for helping with this project in any way you can! diff --git a/LICENSE b/LICENSE.md similarity index 100% rename from LICENSE rename to LICENSE.md diff --git a/README.md b/README.md index 4ac32214..22cc880c 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ A system for managing the occupancy of lots. Built with **cemetery management** in mind, but flexible enough to handle marinas and campgrounds as well. -[User Documentation (In The Works)](docs/) +[**User Documentation**](docs/) (In The Works) ## Key Features @@ -26,6 +26,11 @@ This system can run "out-of-the-box" without maps, with the option to add them w ## About this Project +- [Code of Conduct](CODE_OF_CONDUCT.md) +- [Contributing Guidelines](CONTRIBUTING.md) +- [Security Policy](SECURITY.md) +- [MIT Licence](LICENSE.md) + Although the system is quite niche, it's being released in an open source environment in hopes to pool developer resources from other municipalities looking to move away from older, legacy systems. It is being shared to start the dialog among other municipalities and present an option to those who may be looking to refresh their own cemetery systems. diff --git a/SECURITY.md b/SECURITY.md index a9f86b75..2a832736 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -9,7 +9,7 @@ Due to limited resources, only the latest version is supported only for security ## Reporting a Vulnerability To report a security vulnerability, -please email [corporateapps@cityssm.on.ca](mailto:corporateapps@cityssm.on.ca). +please email . Every attempt will be made to resolve confirmed vulnerabilities in a timely manner.