GitHub Templates: Issue Templates and Pull Request Template

[janpio]

This PR adds documentation on GitHub Templates and adds suggested templates.

Its content is the result of this discussion on the mailing list: https://lists.apache.org/thread.html/fe1d0c812b24826bec74ff07e487806a3b5ad8aa1ae882c0294cb6bd@%3Cdev.cordova.apache.org%3E

You can try the issue templates at this repository: https://github.com/janpio/cordova-github-templates/issues/new/choose https://github.com/janpio/cordova-github-templates/issues/new (Pull Request template unfortunately is not that easy, you have to look at the source here)

I don't expect the templates I wrote to match all situations and survive contact with actual users - so please make suggestion on what is missing, could be improved, changed and so on.

Note that whatever we merge here will not be final and those are just text files that will be able to be edited at any time. This is just the starting point.

---

The section "Distribute GitHub Templates to all repositories" is currently just a TODO, we will have to find a solution for that problem later and describe it via another PR.

---

Please feel free to nitpick any language and grammar problems - I rewrote this quite often, so it is very possible there are some "organically grown" sentences that could use some polishing.

[shazron]

LGTM. To test, I checked out all 3 issue types and created a PR.

[raphinesse]

Another thing that would be great to have in the bug template is:

Could you reproduce the bug in master/a recent nightly build? (Link to docs on how to do that)

[janpio]

I see you raised your hand to write the documentation on how to use nightly builds of anything ;)

[raphinesse]

I see you raised your hand to write the documentation on how to use nightly builds of anything ;)

:grin: Didn't someone write docs about that recently?

But seriously, I see so many issues where people didn't check master and it's possibly already fixed there. At least installing a nightly build of the CLI isn't hard to do nor document:

npm i cordova@nightly

(We will have to make sure to only tag nightly builds when the build actually succeeds, but that's a different story)

[janpio]

That would result in something like this I guess:

[ ] I checked that my issue is still present when using a Nightly Build (npm install -g cordova@nightly)

Agree? When does having a nightly CLI actually help? For platforms and plugins as well?

Problem is that most Cordova users are not using nvm, so they are effectively "destroying" their working environment when they mess with any of our components and don't really have a way to go back :/

[raphinesse]

Agree?

Yes

When does having a nightly CLI actually help? For platforms and plugins as well?

Mostly for errors that occur while using the CLI, I guess. Adding platforms and plugins and preparing the project are favorites.

Problem is that most Cordova users are not using nvm, so they are effectively "destroying" their working environment when they mess with any of our components and don't really have a way to go back :/

That's a valid point. Would be less problematic if people were using a local cordova installation. Someone should write docs for best practices :grin:

A solution for moderately recent setups would be

npx cordova@nightly <YOUR COMMAND>

[raphinesse]

If the situation is more complicated for plugins and platforms, we can add that section only for tooling repos after rolling out the templates.

[janpio]

Adding platforms and plugins and preparing the project are favorites.

So this would be mainly useful on the cordova-cli repo, not on the platform or plugin repos, right? Because that is an issue that should be created there if someone has problems with that, correct?

Would be less problematic if people were using a local cordova installation. Someone should write docs for best practices 😁

Keep in mind that on Windows that might not be that simple.

But yes, updating the "Install and run Cordova" docs might be nice, especially now that npx exists.

[raphinesse]

Keep in mind that on Windows that might not be that simple.

What do you mean? Why would you not be able to have a local installation and run cordova through npm scripts or npx?

[janpio]

Because "run cordova through npm scripts or npx" is more complicated than install -g and just run cordova on the command line (as people don't know what npm scripts are and may be using a npm without npx).

[raphinesse]

@janpio I agree, but I don't see how that has to do with users running Cordova on Windows or not :confused:

[janpio]

On macOS and Linux you can run local files and scripts pretty simple. On Windows you have to mess with PATH or an executable - which is why -g was always preferred. Wrong?