Supporting Your Automation with Community
Table of Contents
To save time and provide a consistent experience, we have default health files for you to customize
At 100 Automations, we’re committed a building a strong community who shared value is reduction of repetitive work – whether that is from not having to write code more than once or answer the same question more than once for a lack of documentation.
Additionally, we seek to reduce the amount of time that individual authors will have to spend to properly monitor the people using and contributing to these automations by creating a shared support space, which you’ll see referenced in the contributing, support, and security files.
100Automations wants to list your automation. In order to do that your automation needs to have the following files:
CONTRIBUTING.md
The contributing.md file communicates how people should contribute to your project.
Include the type of contribution you’re looking for. For example:
- maintenance
- refactoring
- peer review
- advice
- coding
Template:
- Default CONTRIBUTING.md file from our template repository
Example from a project:
Additional resources:
- GitHub guide: Setting guidelines for repository contributors
SECURITY.md
The security.md file tells how people can safely report a security vulnerability in your automation.
Template:
- Default SECURITY.md file from our template repository
Example from a project:
Additional resources:
- GitHub guide: Adding a security policy to your repository
SUPPORT.md
The support.md files lets people know how to get help implementing your automation
Template:
- Default SUPPORT.md file from our template repository
Example from a project:
Additional resources:
- see GitHub Adding support resources to your project tutorial
README.md
Usually the first place developers look, so it should be fairly comprehensive with links to the other health files.
Guide:
- 100 Automations Guide: Creating a Good Read.me for Your Automation
Template:
- Default README.md file from our template repository
Example from a project:
Additional resources:
- see GitHub’s guide: https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/about-readmes
LICENSE
We recommend GNU 2.0
Template:
- Default LICENSE file from our template repository
Example from a project:
Additional resources:
- see GitHub Adding a license to a repository
CODE_OF_CONDUCT.md
Your new repo will contain a Code of Conduct file.
You just need to add your project name. Please do not edit any other details. If you have suggested revisions, please let us know by opening an issue.
If importing your automation from your own repository, add our default Code of Conduct
Template:
- Default CODE_OF_CONDUCT.md file from our template repository
Example from a project:
Additional resources:
- See GitHub Adding a code of conduct to your project