-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #262 from dinger1986/main
added contributing reporting templates
- Loading branch information
Showing
2 changed files
with
23 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Reporting Templates | ||
|
||
## Template Names | ||
|
||
Templates should be named in such a way it is clear and concise for others to know what the template does. | ||
|
||
## Prerequisites | ||
Before you begin, ensure you are: | ||
|
||
- Familiar with the report data available in Tactical RMM. Read more about reporting [here](https://docs.tacticalrmm.com/ee/reporting/reporting_overview/). | ||
- Up and running with Tactical RMM, for testing purposes (you can safely use your live environment). | ||
- Creating a new/unique Report Template, existing templates are available [here](https://github.com/amidaware/reporting-templates). | ||
|
||
## Once your template is ready: | ||
|
||
1. Fork the Tactical RMM template repository on GitHub. | ||
2. Export your template from Tactical RMM Reporting manager by right clicking and clicking export. | ||
3. Create a new template in the templates folder and copy and paste in code or upload exported template. | ||
4. Create a pull request with a brief description of your template and why it's useful. | ||
5. The Tactical RMM team will review your submission and test it, provide tests pass etc your PR will be accepted, if theres issues feedback will be provided in the comments section of the PR. | ||
|
||
Thank you for contributing to Tactical RMM and helping enhance the reporting capabilities for all users! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters