forked from avanov/ansible-galaxy-pyenv
-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
76 additions
and
3 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,64 @@ | ||
Contributor Guide | ||
================= | ||
|
||
Thank you for your interest in improving this project. | ||
This project is open-source under the `MIT license`_ and | ||
welcomes contributions in the form of bug reports, feature requests, and pull requests. | ||
|
||
Here is a list of important resources for contributors: | ||
|
||
- `Source Code`_ | ||
- `Issue Tracker`_ | ||
- `Code of Conduct`_ | ||
|
||
.. _MIT license: https://opensource.org/licenses/MIT | ||
.. _Source Code: https://github.com/staticdev/ansible-role-pyenv | ||
.. _Issue Tracker: https://github.com/staticdev/ansible-role-pyenv/issues | ||
|
||
How to report a bug | ||
------------------- | ||
|
||
Report bugs on the `Issue Tracker`_. | ||
|
||
When filing an issue, make sure to answer these questions: | ||
|
||
- Which operating system and Ansible version are you using? | ||
- Which version of this project are you using? | ||
- What did you do? | ||
- What did you expect to see? | ||
- What did you see instead? | ||
|
||
The best way to get your bug fixed is to provide a test case, | ||
and/or steps to reproduce the issue. | ||
|
||
|
||
How to request a feature | ||
------------------------ | ||
|
||
Request features on the `Issue Tracker`_. | ||
|
||
How to submit changes | ||
--------------------- | ||
|
||
Open a `pull request`_ to submit changes to this project. | ||
|
||
Your pull request needs to meet the following guidelines for acceptance: | ||
|
||
- The Nox test suite must pass without errors and warnings. | ||
- Include unit tests. This project maintains 100% code coverage. | ||
- If your changes add functionality, update the documentation accordingly. | ||
|
||
Feel free to submit early, though—we can always iterate on this. | ||
|
||
To run linting and code formatting checks before commiting your change, you can install pre-commit as a Git hook by running the following command: | ||
|
||
.. code:: console | ||
$ nox --session=pre-commit -- install | ||
It is recommended to open an issue before starting work on anything. | ||
This will allow a chance to talk it over with the owners and validate your approach. | ||
|
||
.. _pull request: https://github.com/staticdev/ansible-role-pyenv/pulls | ||
.. github-only | ||
.. _Code of Conduct: CODE_OF_CONDUCT.rst |
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