The files in this repo are markdown templates for Github.
You can use them to configure a already created repository and improved its usability.
If you are starting a new repo from scratch, I do recommend using this other repository; https://github.com/ivan-pinatti/github-template and use the 'Use this template' button.
If you are trying to template Github repos for your organization, please check the official documentation at https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-template-repository
All the files here are submitted to the other repo, https://github.com/ivan-pinatti/github-template, and it is possible to check how they will work by trying to submit an issue or a pull request.
On your shell follow the steps below.
Define your repo folder
MY_TARGET_REPO_FOLDER=/home/${USER}/workspace/github-templateCreate the .github folder and the ISSUE_TEMPLATE folders if they don't exist yet
mkdir --parents ${MY_TARGET_REPO_FOLDER}/.github/ISSUE_TEMPLATECopy the markdown template files to the newly created .github folder
find */ -iname '*.md' -exec cp {} ${MY_TARGET_REPO_FOLDER}/.github/ISSUE_TEMPLATE \;Copy the config file to the newly created .github folder
cp Config/config.yml ${MY_TARGET_REPO_FOLDER}/.github/ISSUE_TEMPLATE/
See LICENSE for full details.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
If you are using the code, entirelly or partially, forking the project, or getting inspired by it, consider buying me a coffee or maybe a beer, I would really appreciate it 😃
