Initial commit
This commit is contained in:
parent
53430f857b
commit
c67e8642c8
12 changed files with 673 additions and 2 deletions
73
.gitea/issue_template.md
Normal file
73
.gitea/issue_template.md
Normal file
|
|
@ -0,0 +1,73 @@
|
||||||
|
---
|
||||||
|
|
||||||
|
name: "Bug"
|
||||||
|
about: "Report a bug to be fixed."
|
||||||
|
title: "[fix]/master "
|
||||||
|
ref: "master"
|
||||||
|
labels:
|
||||||
|
|
||||||
|
- bug
|
||||||
|
- "help wanted"
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Environment (answer all that apply)
|
||||||
|
|
||||||
|
Operating System (OS) name and version:
|
||||||
|
|
||||||
|
libc name and version:
|
||||||
|
|
||||||
|
Browser name and version:
|
||||||
|
|
||||||
|
Version of each dependency:
|
||||||
|
|
||||||
|
Hardware:
|
||||||
|
|
||||||
|
\<list any relevant environment variables, software, or other context here>
|
||||||
|
|
||||||
|
### Expected behavior
|
||||||
|
|
||||||
|
\<describe the expected behavior here>
|
||||||
|
|
||||||
|
### Current behavior
|
||||||
|
|
||||||
|
\<describe the current behavior here>
|
||||||
|
|
||||||
|
### Steps to Reproduce
|
||||||
|
|
||||||
|
\<list the steps to reproduce here>
|
||||||
|
|
||||||
|
1.
|
||||||
|
2.
|
||||||
|
3.
|
||||||
|
...
|
||||||
|
|
||||||
|
### Error messages
|
||||||
|
|
||||||
|
\<please provide any error messages in code blocks with a label above>
|
||||||
|
|
||||||
|
\<message labeling the error>:
|
||||||
|
```
|
||||||
|
<error message>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Unit tests, Integration tests, or System tests
|
||||||
|
|
||||||
|
\<please provide any relevant unit tests below>
|
||||||
|
\<please provide any relevant integration tests below>
|
||||||
|
\<please provide any relevant system tests below>
|
||||||
|
|
||||||
|
### Stack trace (if relevant)
|
||||||
|
|
||||||
|
### Logs (if any)
|
||||||
|
|
||||||
|
### Possible solution(s)
|
||||||
|
|
||||||
|
\<describe any possible solutions here>
|
||||||
|
|
||||||
|
### If bug is confirmed, are you willing to submit a PR and contribute?
|
||||||
|
|
||||||
|
[ ] yes
|
||||||
|
[ ] no
|
||||||
|
[ ] maybe
|
||||||
|
[ ] what's a PR?
|
||||||
73
.gitea/issue_template/dev_bug.md
Normal file
73
.gitea/issue_template/dev_bug.md
Normal file
|
|
@ -0,0 +1,73 @@
|
||||||
|
---
|
||||||
|
|
||||||
|
name: "Dev branch Bug"
|
||||||
|
about: "Report a bug to be fixed."
|
||||||
|
title: "[fix]/dev "
|
||||||
|
ref: "dev"
|
||||||
|
labels:
|
||||||
|
|
||||||
|
- bug
|
||||||
|
- "help wanted"
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Environment (answer all that apply)
|
||||||
|
|
||||||
|
Operating System (OS) name and version:
|
||||||
|
|
||||||
|
libc name and version:
|
||||||
|
|
||||||
|
Browser name and version:
|
||||||
|
|
||||||
|
Version of each dependency:
|
||||||
|
|
||||||
|
Hardware:
|
||||||
|
|
||||||
|
\<list any relevant environment variables, software, or other context here>
|
||||||
|
|
||||||
|
### Expected behavior
|
||||||
|
|
||||||
|
\<describe the expected behavior here>
|
||||||
|
|
||||||
|
### Current behavior
|
||||||
|
|
||||||
|
\<describe the current behavior here>
|
||||||
|
|
||||||
|
### Steps to Reproduce
|
||||||
|
|
||||||
|
\<list the steps to reproduce here>
|
||||||
|
|
||||||
|
1.
|
||||||
|
2.
|
||||||
|
3.
|
||||||
|
...
|
||||||
|
|
||||||
|
### Error messages
|
||||||
|
|
||||||
|
\<please provide any error messages in code blocks with a label above>
|
||||||
|
|
||||||
|
\<message labeling the error>:
|
||||||
|
```
|
||||||
|
<error message>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Unit tests, Integration tests, or System tests
|
||||||
|
|
||||||
|
\<please provide any relevant unit tests below>
|
||||||
|
\<please provide any relevant integration tests below>
|
||||||
|
\<please provide any relevant system tests below>
|
||||||
|
|
||||||
|
### Stack trace (if relevant)
|
||||||
|
|
||||||
|
### Logs (if any)
|
||||||
|
|
||||||
|
### Possible solution(s)
|
||||||
|
|
||||||
|
\<describe any possible solutions here>
|
||||||
|
|
||||||
|
### If bug is confirmed, are you willing to submit a PR and contribute?
|
||||||
|
|
||||||
|
[ ] yes
|
||||||
|
[ ] no
|
||||||
|
[ ] maybe
|
||||||
|
[ ] what's a PR?
|
||||||
36
.gitea/issue_template/feature_request.md
Normal file
36
.gitea/issue_template/feature_request.md
Normal file
|
|
@ -0,0 +1,36 @@
|
||||||
|
---
|
||||||
|
|
||||||
|
name: "Feature Request"
|
||||||
|
about: "Suggest a feature to be implemented."
|
||||||
|
title: "[FR]/master "
|
||||||
|
ref: "master"
|
||||||
|
labels:
|
||||||
|
|
||||||
|
- enhancement
|
||||||
|
- "help wanted"
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Detailed Description
|
||||||
|
|
||||||
|
\<describe what you want the feature to do>
|
||||||
|
|
||||||
|
### Possible Implementation
|
||||||
|
|
||||||
|
\<describe how you would implement the feature>
|
||||||
|
|
||||||
|
### Environment (answer all that apply)
|
||||||
|
|
||||||
|
Operating System (OS) name and version:
|
||||||
|
libc name and version:
|
||||||
|
Browser name and version:
|
||||||
|
Version of each dependency:
|
||||||
|
|
||||||
|
\<list any relevant environment variables, software, or other context here>
|
||||||
|
|
||||||
|
### If FR is approved, are you willing to submit a PR and contribute?
|
||||||
|
|
||||||
|
[ ] yes
|
||||||
|
[ ] no
|
||||||
|
[ ] maybe
|
||||||
|
[ ] what's a PR?
|
||||||
30
.gitea/issue_template/question.md
Normal file
30
.gitea/issue_template/question.md
Normal file
|
|
@ -0,0 +1,30 @@
|
||||||
|
---
|
||||||
|
|
||||||
|
name: "Question"
|
||||||
|
about: "Ask a question"
|
||||||
|
title: "[?]/master "
|
||||||
|
ref: "master"
|
||||||
|
labels:
|
||||||
|
|
||||||
|
- question
|
||||||
|
- "help wanted"
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Environment (answer all that apply)
|
||||||
|
|
||||||
|
Operating System (OS) name and version:
|
||||||
|
|
||||||
|
libc name and version:
|
||||||
|
|
||||||
|
Browser name and version:
|
||||||
|
|
||||||
|
Version of each dependency:
|
||||||
|
|
||||||
|
Hardware:
|
||||||
|
|
||||||
|
\<list any relevant environment variables, software, or other context here>
|
||||||
|
|
||||||
|
### Question
|
||||||
|
|
||||||
|
\<ask your question here>
|
||||||
31
.gitea/pull_request_template.md
Normal file
31
.gitea/pull_request_template.md
Normal file
|
|
@ -0,0 +1,31 @@
|
||||||
|
---
|
||||||
|
|
||||||
|
name: "Default"
|
||||||
|
about: "Default pull request template"
|
||||||
|
title: "PR/master: "
|
||||||
|
ref: "master"
|
||||||
|
labels:
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
|
||||||
|
### Description
|
||||||
|
|
||||||
|
### Related issue
|
||||||
|
|
||||||
|
### Motivation and Context
|
||||||
|
|
||||||
|
### How has this been tested?
|
||||||
|
|
||||||
|
### Screenshots (if appropriate)
|
||||||
|
|
||||||
|
### Type of change
|
||||||
|
|
||||||
|
[ ] Bug fix or patch (non-breaking fix of an issue: v_._.X)
|
||||||
|
[ ] New feature (non-breaking adding functionality: v_.X._)
|
||||||
|
[ ] Breaking change (fix or feature that breaks existing functionality: vX._._)
|
||||||
|
|
||||||
|
### Have you read our CODE_OF_CONDUCT.md, CONTRIBUTING.md, and other documents?
|
||||||
|
|
||||||
|
[ ] yes
|
||||||
|
[ ] no
|
||||||
4
.gitea/template
Normal file
4
.gitea/template
Normal file
|
|
@ -0,0 +1,4 @@
|
||||||
|
README.md
|
||||||
|
docs/CODE_OF_CONDUCT.md
|
||||||
|
docs/CONTRIBUTING.md
|
||||||
|
docs/SECURITY.md
|
||||||
237
README.md
237
README.md
|
|
@ -1,3 +1,236 @@
|
||||||
# app-template
|
<h1 align="center">
|
||||||
|
<a href="https://gitdab.com/${REPO_OWNER}/${REPO_NAME}">
|
||||||
|
<img src="docs/images/logo.png" alt="Logo" width="100" height="100">
|
||||||
|
</a>
|
||||||
|
<br />
|
||||||
|
${REPO_NAME}
|
||||||
|
</h1>
|
||||||
|
|
||||||
Template for applications
|
> **[?]**
|
||||||
|
> Switch for your own logo
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
<i>${REPO_DESCRIPTION}</i>
|
||||||
|
|
||||||
|
<a href="https://gitdab.com/${REPO_OWNER}/${REPO_NAME}/issues/new">
|
||||||
|
Report a Bug
|
||||||
|
</a>
|
||||||
|
·
|
||||||
|
<a href="https://gitdab.com/${REPO_OWNER}/${REPO_NAME}/issues/new">
|
||||||
|
Request a Feature
|
||||||
|
</a>
|
||||||
|
·
|
||||||
|
<a href="https://gitdab.com/${REPO_OWNER}/${REPO_NAME}/issues/new">
|
||||||
|
Ask a Question
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
<br />
|
||||||
|
|
||||||
|
[](LICENSE)
|
||||||
|
|
||||||
|
[](https://gitdab.com/${REPO_OWNER}/${REPO_NAME}/compare)
|
||||||
|
[](https://gitdab.com/${REPO_NAME})
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
## Table of Contents
|
||||||
|
|
||||||
|
- [About](#about)
|
||||||
|
- [Getting Started](#getting-started)
|
||||||
|
- [Prerequisites](#prerequisites)
|
||||||
|
- [Installation](#installation)
|
||||||
|
- [Usage](#usage)
|
||||||
|
- [Support](#support)
|
||||||
|
- [Roadmap](#roadmap)
|
||||||
|
- [Project Help](#project-help)
|
||||||
|
- [Contributing](#contributing)
|
||||||
|
- [Acknowledgements](#acknowledgements)
|
||||||
|
- [Funding Organizations](#funding-organizations)
|
||||||
|
- [Patrons](#patrons)
|
||||||
|
- [Software Used](#software-used)
|
||||||
|
- [Inspirations](#inspirations)
|
||||||
|
- [Authors and Contributors](#authors-and-contributors)
|
||||||
|
- [Security](#security)
|
||||||
|
- [License](#license)
|
||||||
|
|
||||||
|
## About
|
||||||
|
|
||||||
|
> **[?]**
|
||||||
|
> Provide general information about your project here.
|
||||||
|
> What problem does it (intend to) solve?
|
||||||
|
> What is the purpose of your project?
|
||||||
|
> Why did you undertake it?
|
||||||
|
|
||||||
|
**[Back to top](#table-of-contents)**
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
|
||||||
|
> **[?]**
|
||||||
|
> List project requirements or dependencies.
|
||||||
|
> List build tools.
|
||||||
|
|
||||||
|
**[Back to top](#table-of-contents)**
|
||||||
|
|
||||||
|
### Installation
|
||||||
|
|
||||||
|
> **[?]**
|
||||||
|
> Describe how to install and get started with the project.
|
||||||
|
> List build instructions.
|
||||||
|
|
||||||
|
**[Back to top](#table-of-contents)**
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
> **[?]**
|
||||||
|
> How does one go about using it?
|
||||||
|
> Provide various use cases and code examples here.
|
||||||
|
|
||||||
|
**[Back to top](#table-of-contents)**
|
||||||
|
|
||||||
|
## Support
|
||||||
|
|
||||||
|
> **[?]**
|
||||||
|
> Provide additional ways to contact the project maintainer/maintainers.
|
||||||
|
> Website?
|
||||||
|
> Email?
|
||||||
|
|
||||||
|
**[Back to top](#table-of-contents)**
|
||||||
|
|
||||||
|
## Roadmap
|
||||||
|
|
||||||
|
See the [open issues](https://gitdab.com/${REPO_OWNER}/${REPO_NAME}/issues)
|
||||||
|
for a list of proposed features (and known issues).
|
||||||
|
|
||||||
|
> **[?]**
|
||||||
|
> Show milestones.
|
||||||
|
> Top Feature Requests. (Add your votes using the 👍 reaction)
|
||||||
|
> Newest Bugs. (Add your votes using the 👍 reaction)
|
||||||
|
> Kanban board or other project management software.
|
||||||
|
|
||||||
|
**[Back to top](#table-of-contents)**
|
||||||
|
|
||||||
|
## Project Help
|
||||||
|
|
||||||
|
If you want to say thank you and/or support active development of
|
||||||
|
**${REPO_NAME}**:
|
||||||
|
- Add a [GitHub Star](https://github.com/${REPO_OWNER}/${REPO_NAME}) to the
|
||||||
|
project's GitHub awareness page. This is not a mirror to prevent GitHub
|
||||||
|
Copilot.
|
||||||
|
- Tweet about ${REPO_NAME} or spread the word on other social media.
|
||||||
|
- Write interesting articles about the project on [Dev.to](https://dev.to/),
|
||||||
|
[Medium](https://medium.com/), or your personal blog.
|
||||||
|
- Help fund our contributors on:
|
||||||
|
- [Liberapay](https://liberapay.com)
|
||||||
|
- [Buy me a coffee](https://www.buymeacoffee.com/)
|
||||||
|
- [Ko-Fi](https://ko-fi.com/)
|
||||||
|
- [Patreon](https://www.patreon.com)
|
||||||
|
- [Kickstarter](https://www.kickstarter.com/)
|
||||||
|
- [Indiegogo](https://www.indiegogo.com/)
|
||||||
|
|
||||||
|
> **[?]**
|
||||||
|
> Replace with links to the projects own funding pages.
|
||||||
|
|
||||||
|
Together, we can make ${REPO_NAME} **better**!
|
||||||
|
|
||||||
|
**[Back to top](#table-of-contents)**
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
First off, thanks for taking the time to contribute!
|
||||||
|
Contributions are what make the open-source community such an amazing place to
|
||||||
|
learn, inspire, and create.
|
||||||
|
Any contributions you make will benefit everybody else and are **greatly appreciated**.
|
||||||
|
|
||||||
|
Please read [our contribution guidelines](docs/CONTRIBUTING.md), and thank you
|
||||||
|
for being involved!
|
||||||
|
|
||||||
|
**[Back to top](#table-of-contents)**
|
||||||
|
|
||||||
|
## Acknowledgements
|
||||||
|
|
||||||
|
### Funding Organizations
|
||||||
|
|
||||||
|
> **[?]**
|
||||||
|
> Include any organizations or companies that are funding the project.
|
||||||
|
|
||||||
|
**[Back to top](#table-of-contents)**
|
||||||
|
|
||||||
|
### Patrons
|
||||||
|
|
||||||
|
All patrons can be found at:
|
||||||
|
- [Liberapay](https://liberapay.com)
|
||||||
|
- [Buy me a coffee](https://www.buymeacoffee.com/)
|
||||||
|
- [Ko-Fi](https://ko-fi.com/)
|
||||||
|
- [Patreon](https://www.patreon.com)
|
||||||
|
- [Kickstarter](https://www.kickstarter.com/)
|
||||||
|
- [Indiegogo](https://www.indiegogo.com/)
|
||||||
|
|
||||||
|
> **[?]**
|
||||||
|
> Replace with links to own funding pages w/ patrons listed.
|
||||||
|
|
||||||
|
**[Back to top](#table-of-contents)**
|
||||||
|
|
||||||
|
### Software Used
|
||||||
|
|
||||||
|
- The
|
||||||
|
[Amazing Github Template](https://github.com/dec0dOS/amazing-github-template)
|
||||||
|
for the README.md and some other documents.
|
||||||
|
|
||||||
|
> **[?]**
|
||||||
|
> Include libraries and applications used in the project.
|
||||||
|
|
||||||
|
**[Back to top](#table-of-contents)**
|
||||||
|
|
||||||
|
### Inspirations
|
||||||
|
|
||||||
|
> **[?]**
|
||||||
|
> Include any projects or people that have inspired this project.
|
||||||
|
|
||||||
|
**[Back to top](#table-of-contents)**
|
||||||
|
|
||||||
|
### Authors and contributors
|
||||||
|
|
||||||
|
The original setup of this repository is by ${REPO_OWNER}.
|
||||||
|
|
||||||
|
For a full list of all authors and contributors, see
|
||||||
|
[the contributors page](https://gitdab.com/${REPO_OWNER}/${REPO_NAME}/activity).
|
||||||
|
|
||||||
|
> **[?]**
|
||||||
|
> Replace once w/ contributors once
|
||||||
|
> https://github.com/go-gitea/gitea/issues/847
|
||||||
|
> is implemented.
|
||||||
|
|
||||||
|
**[Back to top](#table-of-contents)**
|
||||||
|
|
||||||
|
## Security
|
||||||
|
|
||||||
|
**${REPO_NAME}** follows good practices of security, but 100% security cannot
|
||||||
|
be assured.
|
||||||
|
**${REPO_NAME}** is provided **"as is"** without any **warranty**. Use at your
|
||||||
|
own risk.
|
||||||
|
|
||||||
|
_For more information and to report security issues, please refer to our [security documentation](docs/SECURITY.md)._
|
||||||
|
|
||||||
|
**[Back to top](#table-of-contents)**
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
Copyright (C) 2022 Clayton Voges
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify it under
|
||||||
|
the terms of the GNU Affero General Public License as published by the Free
|
||||||
|
Software Foundation, version 3.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful, but WITHOUT
|
||||||
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
||||||
|
FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
|
||||||
|
details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License along
|
||||||
|
with this program. If not, see <https://www.gnu.org/licenses/>
|
||||||
|
|
||||||
|
**[Back to top](#table-of-contents)**
|
||||||
|
|
|
||||||
85
docs/CODE_OF_CONDUCT.md
Normal file
85
docs/CODE_OF_CONDUCT.md
Normal file
|
|
@ -0,0 +1,85 @@
|
||||||
|
# Contributor Covenant Code of Conduct
|
||||||
|
|
||||||
|
## Our Pledge
|
||||||
|
|
||||||
|
In the interest of fostering an open and welcoming environment, we as
|
||||||
|
contributors and maintainers pledge to make participation in our project and
|
||||||
|
our community a harassment-free experience for everyone, regardless of age,
|
||||||
|
body size, disability, ethnicity, sex characteristics, gender identity and
|
||||||
|
expression, level of experience, education, socio-economic status,
|
||||||
|
nationality, personal appearance, race, religion, or sexual identity and
|
||||||
|
orientation.
|
||||||
|
|
||||||
|
## Our Standards
|
||||||
|
|
||||||
|
Examples of behavior that contributes to creating a positive environment
|
||||||
|
include:
|
||||||
|
|
||||||
|
* Using welcoming and inclusive language
|
||||||
|
* Being respectful of differing viewpoints and experiences
|
||||||
|
* Gracefully accepting constructive criticism
|
||||||
|
* Focusing on what is best for the community
|
||||||
|
* Showing empathy towards other community members
|
||||||
|
|
||||||
|
Examples of unacceptable behavior by participants include:
|
||||||
|
|
||||||
|
* The use of sexualized language or imagery and unwelcome sexual attention or
|
||||||
|
advances
|
||||||
|
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||||
|
* Spam
|
||||||
|
* Public or private "harassment" as including the definition in the
|
||||||
|
[Citizen Code of Conduct](http://citizencodeofconduct.org/); if you have
|
||||||
|
any lack of clarity about what might be included in that concept, please
|
||||||
|
read their definition.
|
||||||
|
* Publishing others' private information, such as a physical or electronic
|
||||||
|
address, without explicit permission
|
||||||
|
* Other conduct which could reasonably be considered inappropriate in a
|
||||||
|
professional setting
|
||||||
|
|
||||||
|
## Our Responsibilities
|
||||||
|
|
||||||
|
Project maintainers are responsible for clarifying the standards of
|
||||||
|
acceptable behavior and are expected to take appropriate and fair corrective
|
||||||
|
action in response to any instances of unacceptable behavior.
|
||||||
|
|
||||||
|
Project maintainers have the right and responsibility to remove, edit, or
|
||||||
|
reject comments, commits, code, wiki edits, issues, and other contributions
|
||||||
|
that are not aligned to this Code of Conduct, or to ban temporarily or
|
||||||
|
permanently any contributor for other behaviors that they deem inappropriate,
|
||||||
|
threatening, offensive, or harmful.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
This Code of Conduct applies within all project spaces, and it also applies
|
||||||
|
when an individual is representing the project or its community in public
|
||||||
|
spaces.
|
||||||
|
Examples of representing a project or community include using an official
|
||||||
|
project email address, posting via an official social media account, or
|
||||||
|
acting as an appointed representative at an online or offline event.
|
||||||
|
Representation of a project may be further defined and clarified by project
|
||||||
|
maintainers.
|
||||||
|
|
||||||
|
## Enforcement
|
||||||
|
|
||||||
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||||
|
reported by contacting the project maintainer using any of the
|
||||||
|
[private contact addresses](https://gitdab.com/${REPO_OWNER}/${REPO_NAME}#support).
|
||||||
|
All complaints will be reviewed and investigated and will result in a
|
||||||
|
response that is deemed necessary and appropriate to the circumstances.
|
||||||
|
The project team is obligated to maintain confidentiality with regard to the
|
||||||
|
reporter of an incident.
|
||||||
|
Further details of specific enforcement policies may be posted separately.
|
||||||
|
|
||||||
|
Project maintainers who do not follow or enforce the Code of Conduct in good
|
||||||
|
faith may face temporary or permanent repercussions as determined by other
|
||||||
|
members of the project's leadership.
|
||||||
|
|
||||||
|
## Attribution
|
||||||
|
|
||||||
|
This Code of Conduct is adapted from the
|
||||||
|
[Contributor Covenant](https://www.contributor-covenant.org), version 1.4,
|
||||||
|
available at
|
||||||
|
<https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
|
||||||
|
|
||||||
|
For answers to common questions about this code of conduct, see
|
||||||
|
<https://www.contributor-covenant.org/faq>
|
||||||
90
docs/CONTRIBUTING.md
Normal file
90
docs/CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,90 @@
|
||||||
|
# Contributing
|
||||||
|
|
||||||
|
When contributing to this repository, please first discuss the change you
|
||||||
|
wish to make via issue, email, or any other method with the owners of this
|
||||||
|
repository before making a change.
|
||||||
|
|
||||||
|
Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it
|
||||||
|
in all your interactions with the project.
|
||||||
|
|
||||||
|
## Request for contributions
|
||||||
|
|
||||||
|
Please contribute to this repository if any of the following is true:
|
||||||
|
- You have expertise in community development, communication, or education
|
||||||
|
- You want open source communities to be more collaborative and inclusive
|
||||||
|
- You want to help lower the burden to first time contributors
|
||||||
|
|
||||||
|
## Contributions
|
||||||
|
|
||||||
|
Prerequisites:
|
||||||
|
|
||||||
|
- Familiarity with
|
||||||
|
[pull requests](https://help.github.com/articles/using-pull-requests) and
|
||||||
|
[issues](https://guides.github.com/features/issues/).
|
||||||
|
- Knowledge of [Markdown](https://help.github.com/articles/markdown-basics/)
|
||||||
|
for editing `.md` documents.
|
||||||
|
|
||||||
|
In particular, this community seeks the following types of contributions:
|
||||||
|
|
||||||
|
- **Ideas**: participate in an issue thread or start your own to have your
|
||||||
|
voice heard.
|
||||||
|
- **Resources**: submit a pull request to add to
|
||||||
|
[RESOURCES.md](docs/RESOURCES.md) with links to related content.
|
||||||
|
- **Outline sections**: help us ensure that this repository is comprehensive.
|
||||||
|
If there is a topic that is overlooked, please add it, even if it is just
|
||||||
|
a stub in the form of a header and single sentence.
|
||||||
|
Initially, most things fall into this category.
|
||||||
|
- **Writing**: contribute your expertise in an area by helping us expand the
|
||||||
|
included content.
|
||||||
|
- **Copy editing**: fix typos, clarify language, and generally improve the
|
||||||
|
quality of the content.
|
||||||
|
- **Formatting**: help keep content easy to read with consistent formatting.
|
||||||
|
|
||||||
|
|
||||||
|
## Development environment setup
|
||||||
|
|
||||||
|
> **[?]**
|
||||||
|
> Proceed to describe how to setup local development environment.
|
||||||
|
> e.g:
|
||||||
|
|
||||||
|
To set up a development environment, please follow these steps:
|
||||||
|
|
||||||
|
1. Clone the repo
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git clone https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.repo_slug}}
|
||||||
|
```
|
||||||
|
|
||||||
|
2. TODO
|
||||||
|
|
||||||
|
## Issues and feature requests
|
||||||
|
|
||||||
|
Have you found a bug in the source code, a mistake in the documentation, or
|
||||||
|
maybe you'd like a new feature?
|
||||||
|
You can help us by
|
||||||
|
[submitting an issue](https://gitdab.com/${REPO_OWNER}/${REPO_NAME}/issues).
|
||||||
|
Before you create an issue, make sure to search the issue archive -- your
|
||||||
|
issue may have already been addressed!
|
||||||
|
|
||||||
|
Please try to create bug reports that are:
|
||||||
|
|
||||||
|
- _Reproducible._ Include steps to reproduce the problem.
|
||||||
|
- _Specific._ Include as much detail as possible: which version, what environment, etc.
|
||||||
|
- _Unique._ Do not duplicate existing opened issues.
|
||||||
|
- _Scoped to a Single Bug._ One bug per report.
|
||||||
|
|
||||||
|
**Even better: Submit a pull request with a fix or new feature!**
|
||||||
|
|
||||||
|
### How to submit a Pull Request
|
||||||
|
|
||||||
|
1. Search our repository for open or closed
|
||||||
|
[Pull Requests](https://gitdab.com/${REPO_OWNER}/${REPO_NAME}/pulls)
|
||||||
|
that relate to your submission.
|
||||||
|
You don't want to duplicate effort.
|
||||||
|
2. Fork the project.
|
||||||
|
3. Create your feature branch (`git checkout -b feat/amazing_feature`).
|
||||||
|
4. Commit your changes (`git commit -m 'feat: add amazing_feature'`) uses
|
||||||
|
[conventional commits](https://www.conventionalcommits.org), so please
|
||||||
|
follow the specification in your commit messages.
|
||||||
|
5. Push to the branch (`git push origin feat/amazing_feature`)
|
||||||
|
6. [Open a Pull Request](https://gitdab.com/${REPO_OWNER}/${REPO_NAME}/compare)
|
||||||
0
docs/RESOURCES.md
Normal file
0
docs/RESOURCES.md
Normal file
16
docs/SECURITY.md
Normal file
16
docs/SECURITY.md
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
# Security Policy
|
||||||
|
|
||||||
|
## Reporting a Vulnerability
|
||||||
|
|
||||||
|
If there are any vulnerabilities in **${REPO_NAME}**, don't hesitate to _report them_.
|
||||||
|
|
||||||
|
1. Use any of the [private contact addresses](https://github.com/${REPO_OWNER}/${REPO_NAME}#support).
|
||||||
|
2. Describe the vulnerability.
|
||||||
|
|
||||||
|
If you have a fix, that is most welcome -- please attach or summarize it in your message!
|
||||||
|
|
||||||
|
3. We will evaluate the vulnerability and, if necessary, release a fix or mitigating steps to address it. We will contact you to let you know the outcome, and will credit you in the report.
|
||||||
|
|
||||||
|
Please **do not disclose the vulnerability publicly** until a fix is released!
|
||||||
|
|
||||||
|
4. Once we have either a) published a fix, or b) declined to address the vulnerability for whatever reason, you are free to publicly disclose it.
|
||||||
BIN
docs/images/logo.png
Normal file
BIN
docs/images/logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 60 KiB |
Loading…
Reference in a new issue