diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index c52f0f48..29153f57 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,14 +7,18 @@ assignees: '' --- -**Describe the bug** +## Summary + A clear and concise description of what the bug is. -**To Reproduce** +### Steps to Reproduce + Steps to reproduce the behavior (commands, environment etc) -**Expected behavior** +### Expected behavior + A clear and concise description of what you expected to happen. -**Logs** +### Logs + Add logs to help explain your problem. Logs to stderr can be generated by using `--no-log` command line option. diff --git a/.github/ISSUE_TEMPLATE/discussion.md b/.github/ISSUE_TEMPLATE/discussion.md new file mode 100644 index 00000000..46ed1288 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/discussion.md @@ -0,0 +1,12 @@ +--- +name: Question +about: Create an issue to get help with project +title: '' +labels: question +assignees: '' + +--- + +## Describe your question below + +A clear and concise description of your issue for which you would like to get help. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 6665601b..63406d5b 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,8 +7,14 @@ assignees: '' --- -**Is your feature request related to a problem? Please describe.** +## Feature summary + +Brief description of the feature required + +### Cause of the feature request + A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -**Describe the solution you'd like** +### Proposed changes and/or features + A clear and concise description of what you want to happen. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..be7821b3 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,13 @@ +## Summary + +Brief description of the pull request. Try to provide clear explanation for major changes. + +Please make sure that branch called either `feature/feature-name` for feature-related pull requests or `bug/bug-name` for bug-related ones. + +Put `closes #ISSUE` in case if the pull requests solves one of the opened issues. + +### Checklist + +- [ ] Tests to cover new code +- [ ] `make check` passed +- [ ] `make tests` passed diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 00000000..32fa47f7 --- /dev/null +++ b/AUTHORS @@ -0,0 +1,2 @@ +Current developers: +Evgenii Alekseev aka arcanis diff --git a/Makefile b/Makefile index 380d82c9..f12c835b 100644 --- a/Makefile +++ b/Makefile @@ -3,7 +3,7 @@ PROJECT := ahriman -FILES := COPYING CONFIGURING.md README.md package src setup.py +FILES := AUTHORS COPYING CONFIGURING.md README.md package src setup.py TARGET_FILES := $(addprefix $(PROJECT)/, $(FILES)) IGNORE_FILES := package/archlinux src/.mypy_cache