This is a template for a README.md file. It is a markdown file that is used to describe a project. It is used to provide information about the project to the users and contributors. It is a good practice to have a README.md file in your project repository.
You can use this template to create a README.md file for your project. You can
- Clone this repository
- Copy the README.md file to your project repository
- Edit the file to add information about your project
There are three environment variables that need to be set for this project to work correctly:
PAT- Your GitHub Personal Access TokenGPG_PRIVATE_KEY- Your GPG Private KeyGPG_PRIVATE_KEY_PASSPHRASE- Your GPG Private Key Passphrase
The PAT environment variable is used by MegaLinter to authenticate with the
GitHub API. The GPG_PRIVATE_KEY and GPG_PRIVATE_KEY_PASSPHRASE environment
variables are used to sign the commits that MegaLinter creates when
APPLY_FIXES is set to true.
If the MegaLinter action is disabled, none of these environment variables are required.
This project uses Conventional Commits. Conventional Commits is a specification for adding human and machine readable meaning to commit messages. It is a lightweight convention on top of commit messages. The specification can be found at conventionalcommits.org.
Specifically, this project uses the bitshifted/git-auto-semver action to automatically increment the version number based on the commit messages:
build,chore,ci,docs,fix,perf,refactor,revert,style,test: bump micro (patch) numberfeat: bump minor version numberBREAKING CHANGE: bump major version number
This project is licensed under the Creative Commons License 1.0 Universal License - see the LICENSE file for details.
Contributions are welcome. Please read the CONTRIBUTING.md file for details.
Please read the CODE_OF_CONDUCT.md file for details on the code of conduct. Long story short, be nice to each other and treat each other with respect, compassion, and empathy, especially when you disagree.
- Wes Dean