Skip to content

Update GitHub Issue and Pull Request templates#25

Open
GedasGa wants to merge 1 commit intoapache:masterfrom
GedasGa:master
Open

Update GitHub Issue and Pull Request templates#25
GedasGa wants to merge 1 commit intoapache:masterfrom
GedasGa:master

Conversation

@GedasGa
Copy link

@GedasGa GedasGa commented May 27, 2019

Motivation and Context

Update GitHub Issues and Pull Request templates.

Description

  • Improve wording
  • Fix grammar mistakes
  • Update Pull Request checklist
  • Remove unnecessary details

For platforms, I would strip this checklist item Prefixed the commit with (platform), if the change only applies to one platform (e.g. (android)).

Also, I would like to remove Platforms affected section for the platform's repositories, maybe electron could have it since it has 3 different platforms.

I create this PR as an open-ended discussion for further improvements and suggestions.

Testing

Checklist

  • I've run the tests to see all new and existing tests pass
  • I added automated test coverage as appropriate for this change
  • Commit is prefixed with (platform) if this change only applies to one platform (e.g. (android))
  • If this Pull Request resolves an issue, I linked to the issue in the text above (and used the correct keyword to close issues using keywords)
  • I've updated the documentation if necessary

@janpio
Copy link
Member

janpio commented May 27, 2019

I feel like we don't necessarily need to include checklist item:Commit is prefixed with (platform)if this change only applies to one platform (e.g.(android)). I would like to remove it because I have barely seen anyone do that.

Also, I would like to remove Platforms affected section for the platform's repositories, maybe electron could have it since it has 3 different platforms.

Both "Platforms affected" and commit prefix apply to the core plugin repositories. There it is very valuable to have this information. But I see that for both platforms and tooling this is not really relevant. Any idea how we could differentiate the template files that are rolled out to the repositories?

@GedasGa
Copy link
Author

GedasGa commented May 27, 2019

I feel like we don't necessarily need to include checklist item:Commit is prefixed with (platform)if this change only applies to one platform (e.g.(android)). I would like to remove it because I have barely seen anyone do that.
Also, I would like to remove Platforms affected section for the platform's repositories, maybe electron could have it since it has 3 different platforms.

Both "Platforms affected" and commit prefix apply to the core plugin repositories. There it is very valuable to have this information. But I see that for both platforms and tooling this is not really relevant. Any idea how we could differentiate the template files that are rolled out to the repositories?

If possible, I believe it would be better to separate the templates and roll different ones for different repositories. For the core repositories, cordova-plugins and tooling (plus maybe electron platform) I would suggest keeping "Platforms affected" section. For other repositories, I would recommend to remove it, since it doesn't any value.

Anyhow, I'm not sure if there's some script that handles everything. Maybe it would be possible to modify it and drop certain lines, for example, depending on if it's a platform or a core repository.

Regarding the checklist item, I've never seen anyone using this commit message pattern. Maybe we could keep it for repositories that have "Platforms affected" section.

@janpio
Copy link
Member

janpio commented May 27, 2019

The script that was used to distribute the current templates is documented at https://github.com/apache/cordova-contribute/blob/master/github-templates.md#distribute-github-templates-to-all-repositories Feel free to build on that to add a way to differentiate between types of repositories that should get different templates.

@GedasGa
Copy link
Author

GedasGa commented May 31, 2019

The script that was used to distribute the current templates is documented at https://github.com/apache/cordova-contribute/blob/master/github-templates.md#distribute-github-templates-to-all-repositories Feel free to build on that to add a way to differentiate between types of repositories that should get different templates.

That script commits straight into the master. I don't have the rights to push straight to the master, and I'm not sure it's the best idea anyway. According to the contributor guidelines, each change should be done via PR from a fork repo branch.

I have created a script that will let me update and commit files. For the PR it would be possible to use GitHub API, not sure if I'll go that far, but It's possible.

Once, this confirmed, I can go ahead and start making changes.

@GedasGa
Copy link
Author

GedasGa commented May 31, 2019

The script that was used to distribute the current templates is documented at https://github.com/apache/cordova-contribute/blob/master/github-templates.md#distribute-github-templates-to-all-repositories Feel free to build on that to add a way to differentiate between types of repositories that should get different templates.

That script commits straight into the master. I don't have the rights to push straight to the master, and I'm not sure it's the best idea anyway. According to the contributor guidelines, each change should be done via PR from a fork repo branch.

I have created a script that will let me update and commit files. For the PR it would be possible to use GitHub API, not sure if I'll go that far, but It's possible.

Once, this confirmed, I can go ahead and start making changes.

Update: implemented auto PRs too.

@janpio

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.

2 participants