Skip to content

Commit

Permalink
Contributing guidelines: improve (#1600)
Browse files Browse the repository at this point in the history
* contributing guidelines: improve

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Shatakshi Mishra <shatakshimishra01@gmail.com>
  • Loading branch information
3 people authored Sep 6, 2023
1 parent 0d062ef commit dd006e0
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
8 changes: 8 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,9 @@ along with its additional dependencies required for testing.
pip install -e .\[test]
```

In case of any errors, try to run `pip install --upgrade pip`. Then run the
above command again.

[virtual environment]: https://docs.python.org/3/library/venv.html

### Testing process and examples
Expand Down Expand Up @@ -208,6 +211,9 @@ modify accordingly if needed.

## Contributing docs

The documentation source code is located under the [docs][docs source] directory
in the repository's root.

We use [mkdocs](https://www.mkdocs.org/) to generate our docs website. You can
trigger the process locally by executing:

Expand All @@ -221,3 +227,5 @@ $ tox -e docs
It is also integrated with [Read The Docs](https://readthedocs.org/) that builds
and publishes each commit to the main branch and generates live docs previews
for each pull request.

[docs source]: https://github.com/ansible/ansible-navigator/tree/main/docs
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,19 @@ A demo of the interface can be found [on YouTube][YT demo].

[//]: # (DO-NOT-REMOVE-docs-intro-END)

## Contributing

Any kind of contribution to this project is very welcome and appreciated,
whether it is a documentation improvement, [bug report][issue],
[pull request][pull request] review, or a patch.

See the [Contributing guidelines][contributing guidelines] for details.

[issue]:https://github.com/ansible/ansible-navigator/issues
[pull request]:https://github.com/ansible/ansible-navigator/pulls
[contributing guidelines]:
https://ansible.readthedocs.io/projects/navigator/contributing/guidelines/

## Quick start

### Installing
Expand Down

0 comments on commit dd006e0

Please sign in to comment.