Documentation Fix: Create the bare minimums #12
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added the default GH templates for bug reports and features
GH does not seem to pickup multiple PR templates. This file was added temporarily to validate this issue (indeed it doesn't and by default only picks up `.github/pull_request_template.md`). Looks like the only way to get multiple templates working is by using URL query parameters as discussed (here)[https://help.github.com/en/github/managing-your-work-on-github/about-automation-for-issues-and-pull-requests-with-query-parameters]
soumik-mukherjee
added
the
documentation
soumik-mukherjee
added a commit
that referenced
this pull request
Apr 16, 2020
* Documentation Fix: Create the bare minimums (#12) * Created the readme file * Update issue templates Added the default GH templates for bug reports and features * Added PR templates * Workaround for GH problem: wont pick multiple PR templates * Removing workaround to test alternate GH does not seem to pickup multiple PR templates. This file was added temporarily to validate this issue (indeed it doesn't and by default only picks up `.github/pull_request_template.md`). Looks like the only way to get multiple templates working is by using URL query parameters as discussed (here)[https://help.github.com/en/github/managing-your-work-on-github/about-automation-for-issues-and-pull-requests-with-query-parameters] * Updated PR templates to remove front matter headings * Publishing readme content * Fixed minor markdown defects * Minor content edits * Fixes done (#14)
soumik-mukherjee
added a commit
that referenced
this pull request
Apr 16, 2020
* Upstream merge for WIP bug branch (#15) * Documentation Fix: Create the bare minimums (#12) * Created the readme file * Update issue templates Added the default GH templates for bug reports and features * Added PR templates * Workaround for GH problem: wont pick multiple PR templates * Removing workaround to test alternate GH does not seem to pickup multiple PR templates. This file was added temporarily to validate this issue (indeed it doesn't and by default only picks up `.github/pull_request_template.md`). Looks like the only way to get multiple templates working is by using URL query parameters as discussed (here)[https://help.github.com/en/github/managing-your-work-on-github/about-automation-for-issues-and-pull-requests-with-query-parameters] * Updated PR templates to remove front matter headings * Publishing readme content * Fixed minor markdown defects * Minor content edits * Fixes done (#14) * Added new Link comp and associated changes
soumik-mukherjee
added a commit
that referenced
this pull request
Apr 16, 2020
* Documentation Fix: Create the bare minimums (#12) * Created the readme file * Update issue templates Added the default GH templates for bug reports and features * Added PR templates * Workaround for GH problem: wont pick multiple PR templates * Removing workaround to test alternate GH does not seem to pickup multiple PR templates. This file was added temporarily to validate this issue (indeed it doesn't and by default only picks up `.github/pull_request_template.md`). Looks like the only way to get multiple templates working is by using URL query parameters as discussed (here)[https://help.github.com/en/github/managing-your-work-on-github/about-automation-for-issues-and-pull-requests-with-query-parameters] * Updated PR templates to remove front matter headings * Publishing readme content * Fixed minor markdown defects * Minor content edits * Fixes done (#14) * BugFix: Issue#9 download button not working (#16) * Upstream merge for WIP bug branch (#15) * Documentation Fix: Create the bare minimums (#12) * Created the readme file * Update issue templates Added the default GH templates for bug reports and features * Added PR templates * Workaround for GH problem: wont pick multiple PR templates * Removing workaround to test alternate GH does not seem to pickup multiple PR templates. This file was added temporarily to validate this issue (indeed it doesn't and by default only picks up `.github/pull_request_template.md`). Looks like the only way to get multiple templates working is by using URL query parameters as discussed (here)[https://help.github.com/en/github/managing-your-work-on-github/about-automation-for-issues-and-pull-requests-with-query-parameters] * Updated PR templates to remove front matter headings * Publishing readme content * Fixed minor markdown defects * Minor content edits * Fixes done (#14) * Added new Link comp and associated changes
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Resolves #10
Describe the changes proposed
Changes proposed in this feature PR
readmefile with content per linked issueUser Guide
Steps for users to use the new behavior:
For
issues, nothing needs to be done differently than the GH workflow.PRnot so lucky, GH doesn't seem to support multiple templates. Follow steps below to use a template with a PR.Using templates with a PR
Comparing changes?template=feature_changes.md?template=bugfix_changes.md?template=upstream_merge.mdCreate Pull RequestbuttonExpected behavior
A clear and concise description of what you expected to happen.
Issues will use the templates per the type selection while raising them.
For PRs, the above steps if followed will open the new PR form with the template pre-populated in the
Writetab. Contributors still need to fill up the template though before submitting (same as with issues)Screenshots
If applicable, add screenshots to evidence testing of the behaviour this change.
N/A
Additional context
Add any other context about the change here.
@soumik-mukherjee