diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d364be9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,14 @@ +# Contributing +Thank you for considering contributing to this project. Contributions help make +this template repository more helpful. This guide outlines how to get involved, +report issues, and submit changes. +## Contributing the documentation +If you have identified any errors in the instructions, please feel free to +submit a pull request with your proposed changes. + +I would also appreciate any suggestions for enhancing the content. If you are +aware of a better alternative to the described option, please feel free to open +an issue or submit a PR. +## Contributing to templates +If you have noticed any error with one of the templates, please feel free to +report an issue. diff --git a/doc/README.md b/doc/README.md deleted file mode 100644 index 65c3de1..0000000 --- a/doc/README.md +++ /dev/null @@ -1,13 +0,0 @@ -# Documentation for Flake Templates - -This is a companion web site for -[flake-templates](https://github.com/akirak/flake-templates). - -## Contributing - -If you have identified any errors in the instructions, please feel free to -submit a pull request with your proposed changes. - -I would also appreciate any suggestions for enhancing the content. If you are -aware of a better alternative to the described option, please feel free to open -an issue or submit a PR.