Improved the pull request and added more issues templates. Fixes #47 #54
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 #50Special 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;
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;
The templates created covers this broad spectrum of issues and would help contributors do the following;
Checklist:
documentation
tagUpdate
I added commits that adds more context to different installation modes.