Added templates

This commit is contained in:
mdecimus 2023-07-25 11:39:28 +02:00
parent 0b990942fe
commit 61174ce02a
5 changed files with 159 additions and 0 deletions

74
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View file

@ -0,0 +1,74 @@
name: I think I found a bug
description: File a bug report issue
title: "[bug]: "
labels: ["bug"]
assignees:
- mdecimus
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report! Use this form only for reporting bugs. If you have a question or problem, please use the [Q&A discussion](https://github.com/stalwartlabs/smtp-server/discussions/new?category=q-a).
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see!
value: "A bug happened!"
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: How can we reproduce the problem?
description: Please provide detailed steps for reproducing the problem.
placeholder: Tell us how to reproduce the problem!
value: "I can reproduce the problem by doing the following steps:"
validations:
required: true
- type: dropdown
id: version
attributes:
label: Version
description: What version of our software are you running?
options:
- v0.3.1
- v0.3.0
- v0.2.0 or lower
validations:
required: true
- type: dropdown
id: directory
attributes:
label: Which directory type are you using for local address resolution?
options:
- SQLite
- mySQL
- PostgreSQL
- LDAP
- SMTP or LMTP
- IMAP4
- type: dropdown
id: os
attributes:
label: What operating system are you using?
options:
- Linux
- Docker
- MacOS
- Windows
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output, set logging level to `trace` if you can't find any relevant errors in the log.
render: shell
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/stalwartlabs/.github/blob/main/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true

11
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View file

@ -0,0 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: I have a question or problem
url: https://stalw.art/docs/faq
about: Read the FAQ
- name: I have a question or problem not covered in the FAQ
url: https://github.com/stalwartlabs/smtp-server/discussions/new?category=q-a
about: Open a Q&A discussion
- name: Join Stalwart's Discord
url: https://discord.gg/aVQr3jF8jd
about: Join our Discord server for help, discussions and release announcements.

View file

@ -0,0 +1,36 @@
name: I have a feature request
description: File a feature request issue
title: "[enhancement]: "
labels: ["enhancement"]
assignees:
- mdecimus
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request form! Use this form only for requesting new features. If you have a question or problem, please use the [Q&A discussion](https://github.com/stalwartlabs/smtp-server/discussions/new?category=q-a).
- type: textarea
id: request
attributes:
label: Which feature or improvement would you like to request?
description: Write a clear and concise description of what you want to happen.
placeholder: "I'd like to see this feature:"
value: "I'd like to see this feature:"
validations:
required: true
- type: textarea
id: problem-related
attributes:
label: Is your feature request related to a problem?
description: Wrote a clear and concise description of what the problem is.
placeholder: Tell us what the problem is!
value: "I'm always frustrated when..."
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/stalwartlabs/.github/blob/main/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true

View file

@ -166,6 +166,9 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
build_docker:
needs:
- build
- cross_build
name: Build Docker image for ${{ matrix.platform }}
runs-on: ubuntu-latest
if: '!cancelled()'

35
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,35 @@
# 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, please follow it in all your interactions with the project.
## Any contributions you make will be under AGPL
This software is licensed under the Affero General Public License (AGPL). Any contributions made to
this project will be under this license. Before any contributions can be made, contributors are
required to sign a Contributor License Agreement (CLA). The purpose of the agreement is to clarify
and document the rights granted by contributors to us.
## Pull Request Process
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
build.
2. Update the README.md with details of changes to the interface, this includes new environment
variables, exposed ports, useful file locations and container parameters.
3. Increase the version numbers in any examples files and the README.md to the new version that this
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
do not have permission to do that, you may request the second reviewer to merge it for you.
## Code of Conduct
We as members, contributors, and leaders pledge to make participation in our community a harassment-free
experience for everyone, regardless of age, body size, visible or invisible 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.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive,
and healthy community.
You can read the full Code of Conduct [here](https://github.com/stalwartlabs/.github/blob/main/CODE_OF_CONDUCT.md).