From 818749b8e5c3d693b9e4778afcb9cd1c4518a7b8 Mon Sep 17 00:00:00 2001 From: Nikolai Mishin Date: Sat, 25 May 2024 22:57:32 +0200 Subject: [PATCH] docs: update contribution guide Signed-off-by: Nikolai Mishin --- .github/CONTRIBUTING.md | 1 - CONTRIBUTING.md | 20 ++++++++++++++++++++ README.md | 12 ++---------- 3 files changed, 22 insertions(+), 11 deletions(-) delete mode 100644 .github/CONTRIBUTING.md create mode 100644 CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md deleted file mode 100644 index a48c5856..00000000 --- a/.github/CONTRIBUTING.md +++ /dev/null @@ -1 +0,0 @@ -See [contributing quick start](todo) on our website. \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..016ab242 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,20 @@ +# Contributing to tenv + +## 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. Commit and sign your Changes (`git commit -s -m 'Add some AmazingFeature'`) + - We use DCO as a per-commit sign-off made by a contributor, stating that they agree to the terms published at https://developercertificate.org/ for that particular contribution. +4. Push to the Branch (`git push origin feature/AmazingFeature`) +5. 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 + +tenv is released under the [Apache 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 52f47700..44a3c255 100644 --- a/README.md +++ b/README.md @@ -1387,17 +1387,9 @@ terraform: Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. -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". -Don't forget to give the project a star! Thanks again! - -1. Fork the Project -2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) -3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) -4. Push to the Branch (`git push origin feature/AmazingFeature`) -5. Open a Pull Request - -

(back to top)

+Check out our [contributing guide](CONTRIBUTING.md) to get started. +Don't forget to give the project a star! Thanks again! ## Community