From d66f981be6213144c1dfbf77a93d3f45c72df562 Mon Sep 17 00:00:00 2001 From: alwaysintreble Date: Mon, 22 Aug 2022 17:39:55 -0500 Subject: [PATCH] Github: templates and new user interface (#870) * move some docs out of readme and link with the headers * PR template * bug report template * task and feature request templates * md cleanup * forgot the template * make expected results separate section * move pr template to .github. remove assignment field on tasks * add headers to pr template * Requested changes * suggested changes from @black-sliver and @SoldierofOrder * Update docs/code_of_conduct.md Co-authored-by: SoldierofOrder <107806872+SoldierofOrder@users.noreply.github.com> * Update docs/contributing.md Co-authored-by: SoldierofOrder <107806872+SoldierofOrder@users.noreply.github.com> * Update docs/contributing.md Co-authored-by: SoldierofOrder <107806872+SoldierofOrder@users.noreply.github.com> Co-authored-by: Hussein Farran Co-authored-by: SoldierofOrder <107806872+SoldierofOrder@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug_report.yaml | 35 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yaml | 17 ++++++++++ .github/ISSUE_TEMPLATE/task.yaml | 10 ++++++ .github/pull_request_template.md | 12 +++++++ README.md | 22 ++----------- docs/code_of_conduct.md | 11 +++++++ docs/contributing.md | 12 +++++++ 7 files changed, 100 insertions(+), 19 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml create mode 100644 .github/ISSUE_TEMPLATE/task.yaml create mode 100644 .github/pull_request_template.md create mode 100644 docs/code_of_conduct.md create mode 100644 docs/contributing.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 000000000000..dff9a56651eb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,35 @@ +name: Bug Report +description: File a bug report. +title: "Bug: " +labels: + - bug +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! If this bug occurred during local generation check your + Archipelago install for a log (probably `C:\ProgramData\Archipelago\logs`) + and upload it with this report, as well as all yaml files used. + - type: textarea + id: what-happened + attributes: + label: What happened? + validations: + required: true + - type: textarea + id: expected-results + attributes: + label: What were the expected results? + validations: + required: true + - type: dropdown + id: version + attributes: + label: Software + description: Where did this bug occur? + options: + - Website + - Local generation + - While playing + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 000000000000..84cee1b7f124 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,17 @@ +name: Feature Request +description: Request a feature! +title: "Category: " +labels: + - enhancement +body: + - type: markdown + attributes: + value: | + Please replace `Category` in the title with what this feature will be targeting, such as Core generation, + website, documentation, or a game. + Note: this is not for requesting new games to be added. If you would like to request a game, the best place to + ask is about it is in the [discord](https://archipelago.gg/discord). + - type: textarea + id: feature + attributes: + label: What feature would you like to see? \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/task.yaml b/.github/ISSUE_TEMPLATE/task.yaml new file mode 100644 index 000000000000..fb677c684ff9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/task.yaml @@ -0,0 +1,10 @@ +name: Task +description: Submit a task to be done. If this is not targeting core, it should likely be elsewhere. +title: "Core: " +labels: + - core + - enhancement +body: + - type: textarea + attributes: + label: What task needs to be completed? \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000000..c7c6471dd008 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,12 @@ +Please format your title with what portion of the project this pull request is +targeting and what it's changing. + +ex. "MyGame4: implement new game" or "Docs: add new guide for customizing MyGame3" + +## What is this fixing or adding? + + +## How was this tested? + + +## If this makes graphical changes, please attach screenshots. diff --git a/README.md b/README.md index 9403159c741e..c8362dddd0ac 100644 --- a/README.md +++ b/README.md @@ -61,26 +61,10 @@ This project makes use of multiple other projects. We wouldn't be here without t * [Ocarina of Time Randomizer](https://github.com/TestRunnerSRL/OoT-Randomizer) ## Contributing -Contributions are welcome. We have a few asks of any new contributors. - -* Ensure that all changes which affect logic are covered by unit tests. -* Do not introduce any unit test failures/regressions. - -Otherwise, we tend to judge code on a case to case basis. It is a generally good idea to stick to PEP-8 guidelines to ensure consistency with existing code. (And to make the linter happy.) - -For adding a new game to Archipelago and other documentation on how Archipelago functions, please see [the docs folder](docs/) for the relevant information and feel free to ask any questions in the #archipelago-dev channel in our discord. +For contribution guidelines, please see our [Contributing doc.](/docs/contributing.md) ## FAQ -For frequently asked questions see the website's [FAQ Page](https://archipelago.gg/faq/en/) +For Frequently asked questions, please see the website's [FAQ Page.](https://archipelago.gg/faq/en/) ## Code of Conduct -We conduct ourselves openly and inclusively here. Please do not contribute to an environment which makes other people uncomfortable. This means that we expect all contributors or participants here to: - -* Be welcoming and inclusive in tone and language. -* Be respectful of others and their abilities. -* Show empathy when speaking with others. -* Be gracious and accept feedback and constructive criticism. - -These guidelines apply to all channels of communication within this GitHub repository. Please be respectful in both public channels, such as issues, and private, such as private messaging or emails. - -Any incidents of abuse may be reported directly to Ijwu at hmfarran@gmail.com. +Please refer to our [code of conduct.](/docs/code_of_conduct.md) diff --git a/docs/code_of_conduct.md b/docs/code_of_conduct.md new file mode 100644 index 000000000000..dd3d154a0290 --- /dev/null +++ b/docs/code_of_conduct.md @@ -0,0 +1,11 @@ +# Code of Conduct +We conduct ourselves openly and inclusively here. Please do not contribute to an environment which makes other people uncomfortable. This means that we expect all contributors or participants here to: + +* Be welcoming and inclusive in tone and language. +* Be respectful of others and their abilities. +* Show empathy when speaking with others. +* Be gracious and accept feedback and constructive criticism. + +These guidelines apply to all channels of communication within this GitHub repository. Please be respectful in both public channels, such as issues, and private ones, such as private messaging or emails. + +Any incidents of abuse may be reported directly to ijwu at hmfarran@gmail.com. diff --git a/docs/contributing.md b/docs/contributing.md new file mode 100644 index 000000000000..adbbf0dea19a --- /dev/null +++ b/docs/contributing.md @@ -0,0 +1,12 @@ +# Contributing +Contributions are welcome. We have a few requests of any new contributors. + +* Ensure that all changes which affect logic are covered by unit tests. +* Do not introduce any unit test failures/regressions. +* Follow styling as designated in our [styling documentation](/docs/style.md). + +Otherwise, we tend to judge code on a case to case basis. + +For adding a new game to Archipelago and other documentation on how Archipelago functions, please see +[the docs folder](docs/) for the relevant information and feel free to ask any questions in the #archipelago-dev +channel in our [Discord](https://archipelago.gg/discord).