Contributing to SubVars¶
We want to make contributing to this project as easy and transparent as possible.
cmd- Contains the file and helpers package.
dirContent related to folder parsing.
docs- Contains the documentation in Markdown format.
home.mdIs the main page rendered when docs website is loaded.
install.mdContains the installation instructions for different packages.
Mkdocs is used for documentation rendering from markdown, you can download the cli and test locally before opening a pull request.
pip install mkdocs-material pip install mdx_include pip install mkdocs-minify-plugin
Commit messages should be well formatted, and to make that "standardized", we are using Conventional Commits.
<type>[<scope>]: <short summary> │ │ │ │ │ └─> Summary in present tense. Not capitalized. No | | period at the end. │ │ │ └─> Scope (optional): eg. common, compiler, authentication, core │ └─> Type: chore, docs, feat, fix, refactor, style, or test.
You can follow the documentation on their website.
We actively welcome your pull requests.
- Fork the repo and create your branch from
- If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Make sure your code lints (
- Make sure your code is well formatted (
We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.
By contributing to PingMe, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.