From def7e5b9d016fa87803875092c768399f5b94976 Mon Sep 17 00:00:00 2001 From: jwobith Date: Wed, 8 Apr 2020 02:04:47 -0400 Subject: [PATCH] add contributing doc --- CONTRIBUTING.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..8a80a71 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,24 @@ +# Contribution Guidelines + +## Table of Contents + +- [Contribution Guidelines](#contribution-guidelines) + - [Introduction](#introduction) + - [Bug reports](#bug-reports) + - [Submit your design](#submit-your-design) + +## Introduction + +This document explains how to contribute changes to the this github project. It assumes you have followed the [installation instructions](https://github.com/jwobith/docker-gitea). + +## Bug reports + +Please search the issues on the issue tracker with a variety of keywords to ensure your bug is not already reported. + +If unique, [open an issue](https://github.com/jwobith/docker-gitea/issues/new) and answer the questions so we can understand and reproduce the problematic behavior. + +## Submit your design + +Submissions and updates are welcome. If you want to change or add something, fork the repo or clone it to your own local machine. After making your edits, submit a [pull request](https://github.com/jwobith/docker-gitea) with a descriptive name and include some details of the changes made. + +If you want to make a proposal or start a discussion, please [file an issue](https://github.com/jwobith/docker-gitea/issues/new). File an issue with your proposed change documented, and make sure to note in the title of the issue that it is a proposal.