# Salt Extension for Formula
Salt Extension providing supporting modules for formulae
## Security
If you discover a security vulnerability, please refer
to [Salt's security guide][security].
## User Documentation
For setup and usage instructions, please refer to the
[User Documentation][docs].
## Contributing
The saltext-formula project welcomes contributions from anyone!
The [Salt Extensions guide][salt-extensions-guide] provides comprehensive instructions on all aspects
of Salt extension development, including [writing tests][writing-tests], [running tests][running-tests],
[writing documentation][writing-docs] and [rendering the docs][rendering-docs].
### Quickstart
To get started contributing, first clone this repository (or your fork):
```bash
# Clone the repo
git clone --origin upstream git@github.com:lkubb/saltext-formula.git
# Change to the repo dir
cd saltext-formula
```
#### Automatic
If you have installed [direnv][direnv], allowing the project's `.envrc` ensures
a proper development environment is present and the virtual environment is active.
Without `direnv`, you can still run the automation explicitly:
```bash
python3 tools/initialize.py
source .venv/bin/activate
```
#### Manual
Please follow the [first steps][first-steps], skipping the repository initialization and first commit.
### Pull request
Always make changes in a feature branch:
```bash
git switch -c my-feature-branch
```
To [submit a Pull Request][submitting-pr], you'll need a fork of this repository in
your own GitHub account. If you followed the instructions above,
set your fork as the `origin` remote now:
```bash
git remote add origin git@github.com:<your_fork>.git
```
Ensure you followed the [first steps][first-steps] and commit your changes, fixing any
failing `pre-commit` hooks. Then push the feature branch to your fork and submit a PR.
### Ways to contribute
Contributions come in many forms, and they’re all valuable! Here are some ways you can help
without writing code:
* **Documentation**: Especially examples showing how to use this project
to solve specific problems.
* **Triaging issues**: Help manage [issues][issues] and participate in [discussions][discussions].
* **Reviewing [Pull Requests][PRs]**: We especially appreciate reviews using [Conventional Comments][comments].
You can also contribute by:
* Writing blog posts
* Sharing your experiences using Salt + Formula
on social media
* Giving talks at conferences
* Publishing videos
* Engaging in IRC, Discord or email groups
Any of these things are super valuable to our community, and we sincerely
appreciate every contribution!
[security]: https://github.com/saltstack/salt/blob/master/SECURITY.md
[salt-extensions-guide]: https://salt-extensions.github.io/salt-extension-copier/
[writing-tests]: https://salt-extensions.github.io/salt-extension-copier/topics/testing/writing.html
[running-tests]: https://salt-extensions.github.io/salt-extension-copier/topics/testing/running.html
[writing-docs]: https://salt-extensions.github.io/salt-extension-copier/topics/documenting/writing.html
[rendering-docs]: https://salt-extensions.github.io/salt-extension-copier/topics/documenting/building.html
[first-steps]: https://salt-extensions.github.io/salt-extension-copier/topics/creation.html#initialize-the-python-virtual-environment
[submitting-pr]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork
[direnv]: https://direnv.net
[issues]: https://github.com/lkubb/saltext-formula/issues
[PRs]: https://github.com/lkubb/saltext-formula/pulls
[discussions]: https://github.com/lkubb/saltext-formula/discussions
[comments]: https://conventionalcomments.org/
[docs]: https://lkubb.github.io/saltext-formula/
Raw data
{
"_id": null,
"home_page": null,
"name": "saltext.formula",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "salt-extension",
"author": null,
"author_email": "lkubb <lkubb@protonmail.com>",
"download_url": "https://files.pythonhosted.org/packages/8e/0f/f3f9080f17cc47eaeb8c66c00cee3803f47d17f09b25b082dbc402ccffd4/saltext_formula-0.3.0.tar.gz",
"platform": "any",
"description": "# Salt Extension for Formula\n\nSalt Extension providing supporting modules for formulae\n\n## Security\n\nIf you discover a security vulnerability, please refer\nto [Salt's security guide][security].\n\n## User Documentation\n\nFor setup and usage instructions, please refer to the\n[User Documentation][docs].\n\n## Contributing\n\nThe saltext-formula project welcomes contributions from anyone!\n\nThe [Salt Extensions guide][salt-extensions-guide] provides comprehensive instructions on all aspects\nof Salt extension development, including [writing tests][writing-tests], [running tests][running-tests],\n[writing documentation][writing-docs] and [rendering the docs][rendering-docs].\n\n### Quickstart\n\nTo get started contributing, first clone this repository (or your fork):\n\n```bash\n# Clone the repo\ngit clone --origin upstream git@github.com:lkubb/saltext-formula.git\n\n# Change to the repo dir\ncd saltext-formula\n```\n\n#### Automatic\nIf you have installed [direnv][direnv], allowing the project's `.envrc` ensures\na proper development environment is present and the virtual environment is active.\n\nWithout `direnv`, you can still run the automation explicitly:\n\n```bash\npython3 tools/initialize.py\nsource .venv/bin/activate\n```\n\n#### Manual\nPlease follow the [first steps][first-steps], skipping the repository initialization and first commit.\n\n### Pull request\n\nAlways make changes in a feature branch:\n\n```bash\ngit switch -c my-feature-branch\n```\n\nTo [submit a Pull Request][submitting-pr], you'll need a fork of this repository in\nyour own GitHub account. If you followed the instructions above,\nset your fork as the `origin` remote now:\n\n```bash\ngit remote add origin git@github.com:<your_fork>.git\n```\n\nEnsure you followed the [first steps][first-steps] and commit your changes, fixing any\nfailing `pre-commit` hooks. Then push the feature branch to your fork and submit a PR.\n\n### Ways to contribute\n\nContributions come in many forms, and they\u2019re all valuable! Here are some ways you can help\nwithout writing code:\n\n* **Documentation**: Especially examples showing how to use this project\n to solve specific problems.\n* **Triaging issues**: Help manage [issues][issues] and participate in [discussions][discussions].\n* **Reviewing [Pull Requests][PRs]**: We especially appreciate reviews using [Conventional Comments][comments].\n\nYou can also contribute by:\n\n* Writing blog posts\n* Sharing your experiences using Salt + Formula\n on social media\n* Giving talks at conferences\n* Publishing videos\n* Engaging in IRC, Discord or email groups\n\nAny of these things are super valuable to our community, and we sincerely\nappreciate every contribution!\n\n[security]: https://github.com/saltstack/salt/blob/master/SECURITY.md\n[salt-extensions-guide]: https://salt-extensions.github.io/salt-extension-copier/\n[writing-tests]: https://salt-extensions.github.io/salt-extension-copier/topics/testing/writing.html\n[running-tests]: https://salt-extensions.github.io/salt-extension-copier/topics/testing/running.html\n[writing-docs]: https://salt-extensions.github.io/salt-extension-copier/topics/documenting/writing.html\n[rendering-docs]: https://salt-extensions.github.io/salt-extension-copier/topics/documenting/building.html\n[first-steps]: https://salt-extensions.github.io/salt-extension-copier/topics/creation.html#initialize-the-python-virtual-environment\n[submitting-pr]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork\n[direnv]: https://direnv.net\n[issues]: https://github.com/lkubb/saltext-formula/issues\n[PRs]: https://github.com/lkubb/saltext-formula/pulls\n[discussions]: https://github.com/lkubb/saltext-formula/discussions\n[comments]: https://conventionalcomments.org/\n[docs]: https://lkubb.github.io/saltext-formula/\n",
"bugtrack_url": null,
"license": "Apache Software License",
"summary": "Salt Extension providing supporting modules for formulae",
"version": "0.3.0",
"project_urls": {
"Documentation": "https://lkubb.github.io/saltext-formula/",
"Homepage": "https://github.com/lkubb/saltext-formula",
"Source": "https://github.com/lkubb/saltext-formula",
"Tracker": "https://github.com/lkubb/saltext-formula/issues"
},
"split_keywords": [
"salt-extension"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2b2a29a7f8c2b76041b8af3275f537d0a880db0ff0d89de482624295cea364d7",
"md5": "94f3634da42aabca2ef00fd4225f0503",
"sha256": "f13bae9580cdb9c7c2182bbe02ec5f493aa6f48a80bcccbe279f3d5f1de8f7f8"
},
"downloads": -1,
"filename": "saltext.formula-0.3.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "94f3634da42aabca2ef00fd4225f0503",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.9",
"size": 17877,
"upload_time": "2024-11-20T00:02:18",
"upload_time_iso_8601": "2024-11-20T00:02:18.627706Z",
"url": "https://files.pythonhosted.org/packages/2b/2a/29a7f8c2b76041b8af3275f537d0a880db0ff0d89de482624295cea364d7/saltext.formula-0.3.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8e0ff3f9080f17cc47eaeb8c66c00cee3803f47d17f09b25b082dbc402ccffd4",
"md5": "ab6a9ce7d2f17535e86774e2c111c232",
"sha256": "084674d31e8cab35e8a1461d23863400ecc4a94b77bebac9075272d15809d9ed"
},
"downloads": -1,
"filename": "saltext_formula-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "ab6a9ce7d2f17535e86774e2c111c232",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 81994,
"upload_time": "2024-11-20T00:02:19",
"upload_time_iso_8601": "2024-11-20T00:02:19.654505Z",
"url": "https://files.pythonhosted.org/packages/8e/0f/f3f9080f17cc47eaeb8c66c00cee3803f47d17f09b25b082dbc402ccffd4/saltext_formula-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-20 00:02:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lkubb",
"github_project": "saltext-formula",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "saltext.formula"
}
JSON
