From 8de72e988244a6781306f55aab95d865959f47ec Mon Sep 17 00:00:00 2001 From: Vincent Composieux Date: Fri, 18 Oct 2019 20:17:47 +0200 Subject: [PATCH] Added .github files --- .github/CONTRIBUTING.md | 71 ++++++++++++++++++++++++ .github/FUNDING.yml | 3 + .github/ISSUE_TEMPLATE/issue-template.md | 29 ++++++++++ 3 files changed, 103 insertions(+) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/FUNDING.yml create mode 100644 .github/ISSUE_TEMPLATE/issue-template.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..749b51e --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,71 @@ +# Contributing + +Gocache is an open source project, completely opened to be a community-driven project. + +If you'd like to contribute, you are free to do so. + +## Why contributing? + +The best way to start contributing is to help others. This includes: + +- Reporting new bugs or adding details to existing ones +- Trying to reproduce unconfirmed bugs +- Quick typo fix or documentation improvement +- Participating in discussions + +After becoming familiar with this project, you could contribute in other ways, such as: + +- Helping fix bugs (issues) +- Implement new features you think it could be interesting for others +- Publishing guides, tutorials, and examples + +## Questions + +If you have a question, please feel free to open a new issue on this repository. + +## Bug Reports + +Search through [Github Issues](https://github.com/eko/gocache/issues) to see if the bug has already been reported. If so, please comment with any additional information. + +New bug reports must include: + +1. Detailed description of faulty behavior +2. Steps for reproduction or failing test case +3. Expected and actual behaviors +4. Platforms (OS **and** versions) affected +5. Any information you think it could help identifing the cause of your issue + +Lacking reports may be autoclosed with a link to these instructions. + +## Feature Requests + +Search through [Github Pull Requests](https://github.com/eko/gocache/pulls) to see if someone has already suggested the feature. If so, please provide support with a [reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments) and add your own use case. + +To open a new feature request, please include: + +1. A detailed description of the feature +2. Why this feature belongs in project core, instead of your own application logic +3. Background of where and how you are using the project +4. The use case that would be enabled or improved for your product, if the feature was implemented + +Features are prioritized based on real world users and use cases, not theoretically useful additions for other unknown users. Lacking feature requests may be autoclosed with a link to this section. + +The more complete and compelling the request, the more likely it will ultimately be implemented. Garnering community support will help as well! + +## Pull Requests + +Non-code Pull Requests such as typo fixes or documentation improvements are highly encouraged and are often accepted immediately. + +Pull Requests modifying source code, including backwards compatible additions, will undergo the most scrutiny, and will almost certainly require a proper discussion of the motivation and merits beforehand. Simply increasing code complexity is a cost not to be taken lightly. + +Pull requests must: + +1. Be forked off the [master](https://github.com/eko/gocache/tree/master) branch. +2. Pass the linter and conform to existing coding styles. +3. Commits are [squashed](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Squashing-Commits) to minimally coherent units of changes. +4. Are accompanied by tests covering the new feature or demonstrating the bug for fixes. +5. Serve a single atomic purpose (add one feature or fix one bug). +6. Introduce only changes that further the PR's singular purpose (ex. do not tweak an unrelated config along with adding your feature). +7. Not break any existing unit or end to end tests. + +**Important:** By issuing a Pull Request you agree to allow the project owners to license your work under the terms of the [License](https://github.com/eko/gocache/blob/master/LICENSE). diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..3f38036 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,3 @@ +# These are supported funding model platforms + +github: [eko] diff --git a/.github/ISSUE_TEMPLATE/issue-template.md b/.github/ISSUE_TEMPLATE/issue-template.md new file mode 100644 index 0000000..b92732e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue-template.md @@ -0,0 +1,29 @@ +--- +name: Issue template +about: Issue template +title: '' +labels: '' +assignees: '' + +--- + +Please describe the a concise description and fill out the details below. It will help others efficiently understand your request and get to an answer instead of repeated back and forth. Providing a [minimal, complete and verifiable example](https://stackoverflow.com/help/mcve) will further increase your chances that someone can help. + +**Steps for Reproduction** + +1. Set up the following "xxxx" value in the `config.yaml` configuration file +2. Launch binary with the following arguments +3. Step Two +4. Step Three + +**Expected behavior**: + +**Actual behavior**: + +**Platforms**: + +Include browser, operating system and respective versions + +**Versions**: + +Which versions are you running?