From a86474a47c4b5b0e4269f6a8fd57897f38650403 Mon Sep 17 00:00:00 2001 From: Andreas Lien Date: Wed, 9 Apr 2025 20:58:14 +0200 Subject: [PATCH 1/3] docs: Add issue templates, contributing guidelines, and code of conduct --- .github/ISSUE_TEMPLATE/bug_report.md | 32 ++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++ .github/PULL_REQUEST_TEMPLATE.md | 40 +++++++ CODE_OF_CONDUCT.md | 127 ++++++++++++++++++++++ CONTRIBUTING.md | 24 ++++ ISSUES.md | 17 +++ README.md | 8 +- docs/Code_Contributions_Guidelines.md | 18 +++ 8 files changed, 284 insertions(+), 2 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 ISSUES.md create mode 100644 docs/Code_Contributions_Guidelines.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..cc768f5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,32 @@ +--- +name: 🐛 Bug report +about: Create a report to help us improve +title: "[BUG] Untitled Bug Issue" +labels: bug +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 an 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] + +**Additional context** +Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..b5c925c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: 🛠 Feature request +about: Suggest an idea for this project +title: "[FR] Untitled Feature Request Issue" +labels: enhancement +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 1~3 use cases of the purposed feature** +A clear and concise description of one or more use cases. Ex. As a ..., I want to ... + +**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. \ 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 0000000..18edee5 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,40 @@ +## Description + + + +## What type of PR is this? (check all applicable) + +- [ ] 🍕 Feature +- [ ] 🐛 Bug Fix +- [ ] 📝 Documentation Update +- [ ] 🎨 Style +- [ ] 🧑‍💻 Code Refactor +- [ ] 🔥 Performance Improvements +- [ ] ✅ Test +- [ ] 🤖 Build +- [ ] 🔁 CI +- [ ] 📦 Chore +- [ ] ⏩ Revert + +## Related Tickets & Documents + + + +## Tested? + +- [ ] 👍 yes +- [ ] 🙅 no, because they aren't needed +- [ ] 🙋 no, because I need help + +## Added to documentation? + +- [ ] 📜 README.md +- [ ] 📖 own file under the docs folder +- [ ] 🙅 no documentation needed + +## [optional] Are there any post-deployment tasks we need to perform? \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..576429f --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,127 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +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. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders 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, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at... +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..250a957 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,24 @@ +# Contributing to UKBot + +Thank you for your interest in `UKBot` and for taking the time to contribute to this project. `UKBot` software behind the weekly contest bot for Wikipedia, and there are many ways you can contribute. + +## Code of conduct + +Can be found [here](/CODE_OF_CONDUCT.md) + +## How can I contribute? + +There are many ways in which you can contribute to `UKBot`. + +### 🐛 Report a bug + +Report bug issues using the [Bug Report](https://github.com/WikimediaNorge/UKBot/issues/new?assignees=&labels=bug&template=bug_report.md&title=%5BBUG%5D+Untitled+Bug+Issue) template. +To help resolve your issue as quickly as possible, read the template and provide the requested information. + +### 🛠 File a feature request + +We welcome all feature requests, whether to add new functionality to `UKBot` or to offer an idea for modifying existing functionality. File your feature request using the [Feature Request](https://github.com/WikimediaNorge/UKBot/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=%5BFR%5D+Untitled+Feature+Request+Issue) template. + +### ⚙️ Close a Bug / Feature issue + +We welcome contributions that help make `UKBot` bug free & improve the experience of our users. You can also find issues tagged `bug` or `enhancement`. Check out our [Code Contribution Guide](docs/Code_Contributions_Guidelines.md) to begin. \ No newline at end of file diff --git a/ISSUES.md b/ISSUES.md new file mode 100644 index 0000000..273d8bd --- /dev/null +++ b/ISSUES.md @@ -0,0 +1,17 @@ +# How to file an issue + +We encourage you to ask for help whenever you think it's needed! We are happy about every question we get because it allows us to better understand your needs, possible misunderstandings, and most importantly a way for you to help us improve `UKBot`. That being said, this document's main purpose is to provide guidelines on how you can report a bug or propose a feature request. + +## Filing issues + +Whether you are trying to report a bug or propose a feature request, [Github issues](https://github.com/WikimediaNorge/UKBot/issues) is for you! + +The `bug report` and `feature request` issue templates are ready for you! + +## The issue life-cycle + +1. User files an issue. +2. The `UKBot` member provides feedback as soon as possible. +3. A conversation or discussion between `UKBot` and the user. +4. A pull request related to the issue will close it. +5. Otherwise, we'll close the issue after seven days of no update. \ No newline at end of file diff --git a/README.md b/README.md index 339ec53..2a97b8a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ -# ukbot +

UKBot

-Bot for updating results in writing contests at Wikipedia, deployed at [ukbot.wmflabs.org](https//ukbot.wmflabs.org). +

Bot for updating results in writing contests at Wikipedia, deployed at ukbot.toolforge.org.

+ +
+

Create with ❤︎ by contributors

+
## Getting Started diff --git a/docs/Code_Contributions_Guidelines.md b/docs/Code_Contributions_Guidelines.md new file mode 100644 index 0000000..c13a9af --- /dev/null +++ b/docs/Code_Contributions_Guidelines.md @@ -0,0 +1,18 @@ +## Getting Started + +We use GitHub to host code, to track issues and feature requests, as well as accept pull requests. +Before raising a pull request, ensure you have raised a corresponding issue and discussed a possible solution with a maintainer. This gives your pull request the highest chance of getting merged quickly. + +## 🍴 Git Workflow + +We use [Github Flow](https://guides.github.com/introduction/flow/index.html), so all code changes happen through pull requests. + +1. Fork the repo and create a new branch from the `develop` branch. +2. Branches are named as `fix/fix-name` or `feature/feature-name` +3. Please test your changes. +4. Once you are confident in your code changes, create a pull request in your fork to the `develop` branch in the `WikimediaNorge/UKBot` base repository. +5. Link the issue of the base repository in your Pull request description. [Guide](https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue) +6. When you raise a pull request, we automatically run tests on our CI. Please ensure that all the tests are passing for your code change. We will not be able to accept your change if the test suite doesn't pass. + +## 🏡 Setup for local development +- In progress \ No newline at end of file From 7397b52d1a61db87a569e2543daa3a1f47b98ab6 Mon Sep 17 00:00:00 2001 From: Andreas Lien Date: Wed, 16 Apr 2025 16:52:53 +0200 Subject: [PATCH 2/3] fix: Correct typos and improve wording in documentation files per review --- .github/PULL_REQUEST_TEMPLATE.md | 6 +++++- CONTRIBUTING.md | 2 +- ISSUES.md | 2 +- README.md | 2 +- docs/Code_Contributions_Guidelines.md | 2 +- 5 files changed, 9 insertions(+), 5 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 18edee5..44b0437 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -37,4 +37,8 @@ Please use this format link issue numbers: Fixes #123 - [ ] 📖 own file under the docs folder - [ ] 🙅 no documentation needed -## [optional] Are there any post-deployment tasks we need to perform? \ No newline at end of file +## [optional] Are there any pre- or post-deployment tasks we need to perform? + + \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 250a957..0017290 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing to UKBot -Thank you for your interest in `UKBot` and for taking the time to contribute to this project. `UKBot` software behind the weekly contest bot for Wikipedia, and there are many ways you can contribute. +Thank you for your interest in `UKBot` and for taking the time to contribute to this project. ``UKBot` software behind the weekly contest bot for Wikipedia, and there are many ways you can contribute. ## Code of conduct diff --git a/ISSUES.md b/ISSUES.md index 273d8bd..0b63d02 100644 --- a/ISSUES.md +++ b/ISSUES.md @@ -4,7 +4,7 @@ We encourage you to ask for help whenever you think it's needed! We are happy ab ## Filing issues -Whether you are trying to report a bug or propose a feature request, [Github issues](https://github.com/WikimediaNorge/UKBot/issues) is for you! +Whether you are trying to report a bug or propose a feature request, [GitHub issues](https://github.com/WikimediaNorge/UKBot/issues) is for you! The `bug report` and `feature request` issue templates are ready for you! diff --git a/README.md b/README.md index 2a97b8a..1bea66b 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@

Bot for updating results in writing contests at Wikipedia, deployed at ukbot.toolforge.org.

-

Create with ❤︎ by contributors

+

Created by Dan Michael and maintained with ❤︎ by contributors

## Getting Started diff --git a/docs/Code_Contributions_Guidelines.md b/docs/Code_Contributions_Guidelines.md index c13a9af..84faf4a 100644 --- a/docs/Code_Contributions_Guidelines.md +++ b/docs/Code_Contributions_Guidelines.md @@ -5,7 +5,7 @@ Before raising a pull request, ensure you have raised a corresponding issue and ## 🍴 Git Workflow -We use [Github Flow](https://guides.github.com/introduction/flow/index.html), so all code changes happen through pull requests. +We use [GitHub Flow](https://guides.github.com/introduction/flow/index.html), so all code changes happen through pull requests. 1. Fork the repo and create a new branch from the `develop` branch. 2. Branches are named as `fix/fix-name` or `feature/feature-name` From b10098cb0fd9e45722b3e5550ebef545ba74ebfc Mon Sep 17 00:00:00 2001 From: Andreas Lien Date: Wed, 16 Apr 2025 16:55:43 +0200 Subject: [PATCH 3/3] refactor: updated to use the Phabricator bug report --- .github/ISSUE_TEMPLATE/bug_report.md | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index cc768f5..e5091c5 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -10,23 +10,18 @@ assignees: '' **Describe the bug** A clear and concise description of what the bug is. -**To Reproduce** +**Steps to replicate the issue** (include links if applicable): Steps to reproduce the behavior: 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See an error -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. +**What happens?**: +Describe what happens when you follow the steps above. -**Desktop (please complete the following information):** -- OS: [e.g. iOS] -- Browser [e.g. chrome, safari] -- Version [e.g. 22] +**What should have happened instead?** +A clear and concise description of what you expected to happen. **Additional context** Add any other context about the problem here. \ No newline at end of file