Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improvement needed to Issue and Pull Requests templates #47

Open
Gbahdeyboh opened this issue Jun 28, 2021 · 0 comments · May be fixed by #54
Open

Improvement needed to Issue and Pull Requests templates #47

Gbahdeyboh opened this issue Jun 28, 2021 · 0 comments · May be fixed by #54
Assignees

Comments

@Gbahdeyboh
Copy link

Is this a BUG REPORT or FEATURE REQUEST?

Choose one: BUG REPORT or FEATURE REQUEST

What happened:

What you expected to happen:

How to reproduce it (as minimally and precisely as possible):

Anything else we need to know?:


Taking a look at the Pull Request & Issue templates, it doesn't quite suite the needs of this repository. Here's why;

Issue Template

  • This repository does(or will) not take code contributions actively, the website code is auto-generated by Docusaurus and there's rarely a need to update the documentation's "code".
  • Majority of the updates(if not all) would be the contents of the documentation being updated mostly by editing, modifying or adding new markdown files.
  • This repository would majorly take improvements to the existing documentations, updates that conform with new releases, or addition of new pages/contents but would rarely ever fix bugs or add features.

With this in mind, I do not think the focus of the issue templates should be bug reports, or feature requests as these are more related to code than they are to documentation.

According to the contribution guide, Litmus documentation contributors are expected to:

  • Improve existing content
  • Create new content
  • Maintain documentation framework
  • Keep documentation builds healthy
  • Manage and publish documentation as part of the Litmus release cycle

I think the issue templates should reflect the above and focus more on how to report issues that actual documentations face, documentation request, clarity, etc rather than issues that would mostly be encountered with regular codebases.

Pull Request

The pull request templates is as shown below;

<!--  Thanks for sending a pull request!  Here are some tips for you -->

**What this PR does / why we need it**:

**Which issue this PR fixes** *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close that issue when PR gets merged)*: fixes #

**Special notes for your reviewer**:

**Checklist:**
-   [ ] Fixes #<issue number>
-   [ ] Signed the commit for DCO to be passed
-   [ ] Labelled this PR & related issue with `documentation` tag

This PR template looks good as it references an issue that already states the problem. But quite often, these issues might not state the solution the PR referenced. It might be helpful to add more context and ask actionable questions on what parts of the documentation changed and what changes were made to it.

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 a pull request may close this issue.

1 participant