Titanium JIRA Archive
Titanium SDK/CLI (TIMOB)

[TIMOB-20424] Support for Github pull request & issue templates

GitHub Issuen/a
TypeStory
PriorityLow
StatusClosed
ResolutionDone
Resolution Date2016-08-04T02:45:06.000+0000
Affected Version/sn/a
Fix Version/sRelease 5.4.0
ComponentsSpecification
Labelsn/a
ReporterHans Knöchel
AssigneeHans Knöchel
Created2016-02-18T08:17:21.000+0000
Updated2016-08-04T02:45:06.000+0000

Description

Github recently published a new feature to create issue- and PR-templates for community contributions. In our case, we would be able to inform the user about the coding guidelines for extending the SDK, the CLA link, the necessary docs etc. For issues, we could mention to create a JIRA ticket first, attach build logs and provide the environment. The required files (PULL_REQUEST_TEMPLATE and ISSUE_TEMPLATE) are placed inside a .github directory. More information: https://github.com/blog/2111-issue-and-pull-request-templates

Comments

  1. Chee Kiat Ng 2016-02-18

    Changed to story since this is more of a task and there's nothing for QE to test.
  2. Hans Knöchel 2016-02-21

    The draft for pull requests can be found here: - [Pull-Request template](https://gist.github.com/hansemannn/4d1a3de809606599acf7) - [Issue template](https://gist.github.com/hansemannn/52dabbfc8c1b2b1745c8) [~fokkezb], feel free to add things to wish to mention. Also, if you have thoughts what we should use for the issue template, let me know!
  3. Fokke Zandbergen 2016-03-01

    We don't have Issues enabled for most repositories since we use JIRA. If we do have repositories with Issues enabled, we need to decide if we actually want that (or just forgot to disable). If we have a valid reason, then we can use the issue template. Left some issues on the gist: https://gist.github.com/hansemannn/52dabbfc8c1b2b1745c8#gistcomment-1711553 (hint: use https://giscus.co/)
  4. Fokke Zandbergen 2016-03-01

    Also left some comments on the PR template: https://gist.github.com/hansemannn/4d1a3de809606599acf7#gistcomment-1711563 Great stuff Hans!
  5. Hans Knöchel 2016-03-01

    Agree in all points. For now, we should only provide the PR template which could be used in all public repositories (starting with titanium_mobile and our most popular appcelerator_modules). PR for titanium_mobile will be up today.
  6. Fokke Zandbergen 2016-03-01

    Be sure to add it under a .github folder. Do we need .github/CONTRIBUTING.md as well? It creates a nice [alert](https://help.github.com/articles/setting-guidelines-for-repository-contributors/).
  7. Hans Knöchel 2016-03-01

    Well, if you have additional content to put into there, sure!
  8. Hans Knöchel 2016-03-01

    PR: https://github.com/appcelerator/titanium_mobile/pull/7787

JSON Source