Add guidelines, Issue templates

This commit is contained in:
Ben Goldsworthy 2021-03-20 23:39:26 +00:00
parent 6d5c1af3ee
commit bad40e2533
4 changed files with 110 additions and 0 deletions

38
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View file

@ -0,0 +1,38 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''
---
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
**Additional context**
Add any other context about the problem here.

View file

@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.

32
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,32 @@
This project welcomes contributions!
Please follow these guidelines when contributing, as it will give your pull
request the best chance of being accepted:
# Requesting Features/Reporting Bugs
- To request a new feature or to report a bug, create an
[Issue](https://github.com/Pear-Trading/FoodLoop-Web/issues/new).
# Contributing Code
- This project uses [Git Flow](https://githubflow.github.io/);
- branch off of `development` to start developing (`git checkout -b <your branch>`);
- ensure that your new branch has a descriptive name and begins with your username;
- create a remote copy of your new branch (`git push`);
- create a draft [merge request](https://github.com/Pear-Trading/FoodLoop-Web/compare);
to merge your branch with `development` — tag any related or to-close Issues; and
- when you think you're finished, un-draft your pull request.
# Commits
- This project uses [Conventional Commits](https://www.conventionalcommits.org); and
- keep individual commits as small as possible.
# Versioning
- This project uses [Semantic Versioning](https://semver.org/).
# Translating
- Translations are welcome!

20
SECURITY.md Normal file
View file

@ -0,0 +1,20 @@
# Security Policy
## Supported Versions
The following versions of this software are currently being supported with
security updates:
| Version | Supported |
| ------- | ------------------ |
| 0.x.x | :white_check_mark: |
## Reporting a Vulnerability
To securely report a vulnerability, please DO NOT create an Issue on this
repository.
Please email [Mark Keating][mkeating] privately with the full details of the
vulnerability.
[mkeating]: mailto:m.keating@shadowcat.co.uk