Skip to content

docs: Add issue templates, contributing guidelines, and code of conduct - #56

Merged
jhsoby merged 3 commits into
mainfrom
feat/CONTRIBUTING
Apr 22, 2025
Merged

docs: Add issue templates, contributing guidelines, and code of conduct#56
jhsoby merged 3 commits into
mainfrom
feat/CONTRIBUTING

Conversation

@DiFronzo

@DiFronzo DiFronzo commented Apr 9, 2025

Copy link
Copy Markdown
Member

First draft to issue templates, contributing guidelines, and code of conduct.

@DiFronzo
DiFronzo requested a review from Copilot April 9, 2025 18:59

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (3)

docs/Code_Contributions_Guidelines.md:8

  • Consider updating 'Github Flow' to 'GitHub Flow' to maintain consistent branding.
We use [Github Flow](https://guides.github.com/introduction/flow/index.html), so all code changes happen through pull requests.

ISSUES.md:7

  • Update 'Github issues' to 'GitHub issues' for consistent capitalization.
Whether you are trying to report a bug or propose a feature request, [Github issues](https://github.com/WikimediaNorge/UKBot/issues) is for you!

CONTRIBUTING.md:3

  • [nitpick] Consider revising the sentence for clarity, for example: 'UKBot is the software behind the weekly contest bot for Wikipedia, offering many ways for you to contribute.'
`UKBot` software behind the weekly contest bot for Wikipedia, and there are many ways you can contribute.

@jhsoby jhsoby left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Thanks! Just a few nitpicky comments. Also Copilot had some good feedback for things to improve

Comment thread .github/PULL_REQUEST_TEMPLATE.md Outdated
- [ ] 📖 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

@jhsoby jhsoby Apr 11, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe change "post-deployment" to "pre- or post-deployment"? Pre-deployment could include changing templates or modules on-wiki in order to accomodate changes here.

Comment thread README.md Outdated
<p align="center">Bot for updating results in writing contests at Wikipedia, deployed at <a href="https://ukbot.toolforge.org/">ukbot.toolforge.org</a>.</p>

<div align="center">
<p>Create with ❤︎ by <a href="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/WikimediaNorge/UKBot/graphs/contributors">contributors</a></p>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

* Created

And I think Dan Michael should be mentioned by name here, without him there wouldn't be anything at all

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be nice if we mimicked the Phabricator bug report form here. So suggestion:

**Describe the bug**
A short summary of the bug.

**Steps to replicate the issue** (include links if applicable):
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See an error

**What happens?**:
Describe what happens when you follow the steps above.

**What should have happened instead?**
A clear and concise description of what you expected to happen.

@DiFronzo
DiFronzo requested a review from jhsoby April 16, 2025 14:57

@jhsoby jhsoby left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@jhsoby
jhsoby merged commit 96537a2 into main Apr 22, 2025
@jhsoby
jhsoby deleted the feat/CONTRIBUTING branch April 22, 2025 09:35
jhsoby pushed a commit that referenced this pull request Jul 21, 2025
…ct (#56)

First draft to issue templates, contributing guidelines, and code of
conduct.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants