From 9168b928bfe06f0e0ad81a137461a5fba8b53d98 Mon Sep 17 00:00:00 2001 From: Nikolai Mishin Date: Sat, 13 Jul 2024 22:11:51 +0200 Subject: [PATCH] Add contribution guide --- CONTRIBUTING.md | 18 ++++++++++++++++++ README.md | 8 ++++++++ 2 files changed, 26 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..846b584 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,18 @@ +# Contributing to ansible-role-openvpn + +## How to contribute + +If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". + +1. Fork the Project +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) +3. Push to the Branch (`git push origin feature/AmazingFeature`) +4. Open a Pull Request + +## Code of Conduct + +We expect all contributors to follow our [Code of Conduct](CODE_OF_CONDUCT.md) when participating in our community. + +## License + +aovpn/ansible-role-openvpn is released under the [MIT License](LICENSE). By contributing to this project, you agree to license your contributions under the same license. diff --git a/README.md b/README.md index 0d7e4c8..b75670e 100644 --- a/README.md +++ b/README.md @@ -211,6 +211,14 @@ Client configuration files are copied to the machine where you ran the ansible-p ## More examples More examples will be provided in future documentation, which will be linked here. Stay tuned! +# Contributing + +Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. + +Check out our [contributing guide](CONTRIBUTING.md) to get started. + +Don't forget to give the project a star! Thanks again! + # License MIT