generated from ansible-community/project-template
-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update docs with contributor info (#13)
- Loading branch information
Showing
3 changed files
with
86 additions
and
0 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
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,68 @@ | ||
# Contributors guide | ||
|
||
Contributions are welcome, and they are greatly appreciated! | ||
Every little bit helps, and credit will always be given. | ||
|
||
## Code of conduct | ||
|
||
Please read and abide by the [Ansible Community Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html) in all interactions with the community. | ||
|
||
## Reporting bugs | ||
|
||
If you find a bug, please open an issue at <https://github.com/ansible-community/awx-operator-helm/issues>. | ||
|
||
Please also include the following information in your issue: | ||
|
||
- Your operating system name and the output of `helm show chart awx-operator/awx-operator` | ||
- Any details about your local setup that might be helpful in troubleshooting. | ||
- Detailed steps to reproduce the bug. | ||
|
||
## Writing code | ||
|
||
Want to fix a bug or implement a feature? | ||
Great! | ||
|
||
Look through the [list of issues](https://github.com/ansible-community/awx-operator-helm/issues) for bugs and features. | ||
You can filter bugs with the `bug` label and features with the `enhancement` label. | ||
Any issue that has the `help wanted` label is available to work on. | ||
|
||
Please assign yourself to the issue or add a comment to the issue and ask someone to assign it to you. | ||
We can then remove the `help wanted` label. | ||
That will let others know you're working on it to avoid duplicate work or conflicting pull requests. | ||
|
||
## Writing documentation | ||
|
||
We encourage you to share your expertise with others in the community. | ||
Writing documentation is a great way to do that. | ||
|
||
We can also use help fixing issues with the docs. | ||
Look through the | ||
[list of issues](https://github.com/ansible-community/awx-operator-helm/issues) | ||
for anything with the `docs` label. | ||
|
||
Please also refer to the | ||
[Ansible documentation style guide](https://docs.ansible.com/ansible/latest/dev_guide/style_guide/index.html) | ||
when writing or fixing docs. | ||
|
||
## Getting in touch | ||
|
||
We welcome your feedback, questions and ideas. | ||
Find out how to reach the community. | ||
|
||
### Ansible forum | ||
|
||
Join the Ansible forum to ask questions, get help, and interact with the | ||
community. | ||
|
||
- [Get Help](https://forum.ansible.com/c/help/6): get help or help others. | ||
Please add appropriate tags if you start new discussions, for example use the | ||
`awx` or `awx-operator` tags. | ||
- [Social Spaces](https://forum.ansible.com/c/chat/4): meet and interact with | ||
fellow enthusiasts. | ||
- [News & Announcements](https://forum.ansible.com/c/news/5): track project-wide | ||
announcements including social events. | ||
|
||
### Subscribing to project updates | ||
|
||
To get release announcements and important changes from the community, see the | ||
[Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn). |
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