Skip to content

Commit

Permalink
Add contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
staticdev committed Aug 17, 2021
1 parent 3e88944 commit 233f7fb
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 3 deletions.
64 changes: 64 additions & 0 deletions CONTRIBUTING.rst
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
15 changes: 12 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Ansible role: pyenv
Ansible role: Pyenv
===================

|Tests|
Expand Down Expand Up @@ -66,11 +66,18 @@ Example Playbook
- venv_name: latest_v38
py_version: 3.8.11
Contributing
------------

Contributions are very welcome.
To learn more, see the `Contributor Guide`_.


License
-------
=======

MIT
Distributed under the terms of the MIT_ license,
*Ansible role Pyenv* is free and open source software.


Author Information
Expand All @@ -79,5 +86,7 @@ Author Information
`staticdev`_. Heavily based on Maxim Avanov's `avanov.pyenv`_

.. _avanov.pyenv: https://galaxy.ansible.com/avanov/pyenv
.. _MIT: https://opensource.org/licenses/MIT
.. _pyenv: https://github.com/yyuu/pyenv
.. _staticdev: https://github.com/staticdev
.. _Contributor Guide: CONTRIBUTING.rst

0 comments on commit 233f7fb

Please sign in to comment.