rticonnextdds-examples icon indicating copy to clipboard operation
rticonnextdds-examples copied to clipboard

Use GitHub templates for PRs, issues...

Open lulivi opened this issue 6 years ago • 10 comments

It would be interesting to make use of Github Builtin Issues and Pull-requests templates and Contributing guidelines as well as modernize the Wiki with new content and entries.

lulivi avatar Nov 06 '19 15:11 lulivi

Oh, it seems they changed the way to do this... we have the templates under the .github/ISSUE_TEMPLATE folder

iblancasa avatar Nov 07 '19 10:11 iblancasa

Yes, there is a new way, but we can use the templates under .github folder.

lulivi avatar Nov 07 '19 15:11 lulivi

Useful repository: https://github.com/stevemao/github-issue-templates

iblancasa avatar Nov 20 '19 11:11 iblancasa

@ManuelJNunez, can you take care of this issue? Thanks!

iblancasa avatar Mar 16 '21 12:03 iblancasa

This repository already contains PR and Issues templates under .github folder.

ManuelJNunez avatar Mar 17 '21 11:03 ManuelJNunez

Yes, but we can improve the contributing.md file to include things like "how to run tests", "how to submit a change" or similar things (as explained in the links shared by @lulivi)

iblancasa avatar Mar 17 '21 13:03 iblancasa

We also could change the PULL_REQUEST_TEMPLATE to something like that:

<!--
:warning: Please, try to follow the template.
:warning: Your pull request title should be short, detailed and understandable for all.
:warning: If your pull request fixes an open issue, please link to the issue.
-->

### Summary


### Details and comments


### Checks

<!-- Change te space between the square brackets to an `x` -->
- [ ] I have updated the documentation accordingly.
- [ ] I have read the [CONTRIBUTING](https://github.com/rticommunity/rticonnextdds-examples/blob/develop/CONTRIBUTING.md) document.

ManuelJNunez avatar Mar 18 '21 08:03 ManuelJNunez

Why don't we delete (or rename) ISSUE_TEMPLATE.md so that we can use the issue templates in .github/ISSUE_TEMPLATE?

ManuelJNunez avatar Mar 22 '21 15:03 ManuelJNunez

@ManuelJNunez ok, go ahead.

iblancasa avatar Mar 22 '21 15:03 iblancasa

totally makes sense

lulivi avatar Mar 22 '21 16:03 lulivi