shared ⚙️
This repository is the central organization for every Monitio project. It defines the universal standards, policies, configuration files and guidelines that apply to every single repository within the Monitio organization.
If you decide to transfer an existing project into Monitio, the information here is mandatory.
Warning
Not all information here is fully finished yet. The CONTRIBUTING.md file is only half done and the CODE_OF_CONDUCT.md has not even been made yet. Contact info will also definitely be wrong until some severe maintenance changes are made.
All Monitio projects must adhere to these policies and guidelines, which are managed directly here in this repository.
- Contribution Guidelines (
CONTRIBUTING.md)- Defines the process for submitting Pull Requests and code quality.
- Community Standards (
CODE_OF_CONDUCT.md)- Outlines the behavioral guidelines expected of all contributors and non-contributors.
- Licensing Policy (
LICENSE.md)- All Monitio code is licensed under the GNU General Public License v3.0 (GPL-3.0).
These files should be used to stay up to standards on the Contribution Guidelines (CONTRIBUTING.md). Before release of a project, specific formatting tools listed here should be used to format code, then you can commit the clean code and compile ready for release.
templates/.prettierrc(may get replaced)- Enforces consistent style across all web-based languages.
scripts/todo.py(may get replaced)- An automated script for tracking multiple different types of
TODOcomments in every language using python.
- An automated script for tracking multiple different types of
VERSIONING.md(permanent)- This is used as a way to show what versioning scheme we are using. In Monitio projects, it is mandatory to use the SemVer Typing versioning scheme.
All projects should use the most updated files in the templates/ directory to improve organization. Projects should regularly check this repository for updates to standards.
- Documentation: Copy the
LICENSE.md,CODE_OF_CONDUCT.mdandCONTRIBUTING.mdfiles into your project root. - Configuration: Copy the necessary configuration files (e.g.,
templates/.prettierrc) into your project root. - Scripts: Integrate other useful Monitio projects or the scripts found in this repo into your project's pre-commit hooks or CI workflow.