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

Improved the pull request and added more issues templates. Fixes #47 #54

Draft
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

Gbahdeyboh
Copy link

@Gbahdeyboh Gbahdeyboh commented Jun 28, 2021

What this PR does / why we need it:
This pull request fixes the issues addressed in issue #47

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

Special notes for your reviewer:

The Pull Request template was improved and the Issue templates were re-organized.

Issue Templates

There are now multiple issue templates that can be found in the .github/ISSUE_TEMPLATE folder.
This way, when contributors want to create a new issue, they will be faced with options to select a template as shown below;

Screenshot 2021-06-28 at 7 56 51 PM

The above shows an option to select one issue template, but in our case, contributors will be faced with three templates that have descriptions that help them decide which is best for their issues.

Why do we need to split issue templates?

There are different reasons why a contributor might want to create an issue. These templates make it quite easy for them to get started. However, one single template cannot suit the needs of all contributions as their intents and contributions would always be different. This is why I created a broader scope of sections for these templates.

There are 3 major things a contributor to any open-source documentation repository issues often want to do, and they are;

  • Suggest the creation of entirely new documents
  • Suggests improvements or report errors on already existing documentation.
  • Report bugs, and make a feature request to the tech used to develop the documentation.

The templates created covers this broad spectrum of issues and would help contributors do the following;

  • It helps contributors quickly decide the category of their issue.
  • It gives them precise questions in each category
  • It makes it more easier for them to file issues when all they have to do is to answer a set of pre-defined questions regardless of what type of issue they have.
  • They have the option to create an issue with nit template if none of the issues meet their needs.

Checklist:

  • Fixes #
  • Signed the commit for DCO to be passed
  • Labelled this PR & related issue with documentation tag

Update

I added commits that adds more context to different installation modes.

@imrajdas imrajdas marked this pull request as draft August 14, 2021 15:44
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.

Improvement needed to Issue and Pull Requests templates
1 participant