Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (47 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

71 lines (47 loc) · 2.19 KB

Thank you for your interest in making this project 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.

Contributions are very welcome

Being a very small team, contributions are greatly appreciated. How can you contribute?

  • 📣 Promote this project!
  • 🆘 Documentation and tutorials
  • 🐞 Submit bug reports (or fix them!)
  • ✨ Request new features (or build them!)

Please note that this project has been written for use by the City of Sault Ste. Marie. Contributions can only be accepted if they do not go against the needs of the City.

Please Read the Code of Conduct

The Code of Conduct document describes how we should act when working together. Be nice! 😉

How to report a bug or suggest an enhancement

If you find a security vulnerability, do NOT open an issue. Email corporateapps@cityssm.on.ca instead.

For all other bug reports, feature requests, or enhancements, open an issue and use the closest template.

Financial Contributions

The City of Sault Ste. Marie does not accept financial contributions for its freely available open source work.

However, this project relies on several packages that do accept donations. Some of the main ones:

  • Leaflet

    • The mapping engine.

  • Bulma

    • The CSS framework.

  • OpenStreetMap

    • The database of map tiles used by ShiftLog.

  • Sindre Sorhus

    • Developer of many packages used in this project.

  • Express

    • The framework the application is built on.

  • Node.js

    • The platform the application runs on.

To see all of the packages used by this project that accept donations, run the following command.

npm fund

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! 🙌