-
Notifications
You must be signed in to change notification settings - Fork 28
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
GitHub migration proposal #75
Merged
purplecabbage
merged 3 commits into
apache:master
from
audreyso:github_migration_proposal
Apr 5, 2023
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| # Migration of Jira Issues to Github | ||
| - Status: Proposed | ||
|
|
||
| ## Overview | ||
| This is a proposal to migrate Jira issues over to GitHub. [See issue CB-13157](https://issues.apache.org/jira/browse/CB-13157) | ||
|
|
||
| ## Current | ||
| Currently, issues for all Cordova repos are tracked on [Jira](issues.apache.org/jira/browse/CB). | ||
|
|
||
| ## Proposal | ||
| This proposal recommends that issues are mirgated from Jira to Github so that the issues are with the code. This is recommended because: | ||
| * Jira can be a barrier to actually creating issues. | ||
| * This is an expected open source workflow. | ||
| * This helps to modernize Cordova. | ||
| * Issues should be with the code. | ||
|
|
||
| There are two potential options when using Github to track issues: | ||
|
|
||
| ## Option 1 | ||
| When issues are migrated to Github, each repository will contain its own set of issues. In each repo, there will be a list of the issues, which can be found under the Github "Issues" tab. Therefore, the issues can be found with the code. This can allow developers to reference pull requests more easily. Developers will also be able to "watch" repos and receive notifications when pull requests are sent or when new issues are created. We encourage and want to make it easy for committers to watch Github for the repos they want to be involved in. | ||
|
|
||
| ## Option 2 | ||
| When issues are migrated to Github, they are added to one "issues" repository. There will be one master “issues” repo that can track all of the Cordova issues on GitHub. | ||
|
|
||
| ## Notes | ||
| In both of these scenarios, issues are migrated over from Jira to Github. Jira will continue to be around for security issues. Alternatively, we could use a private GitHub repo for security tracking (if private repos are an option on the Github Apache org). | ||
|
|
||
| There will also be standard labels to follow to help tag each issues. It would be nice to agree on a suggested labels list to help tag and organize issues. List of potential labels include: | ||
|
|
||
| ### Type | ||
| * Bug | ||
| * Enhancement/new feature | ||
| * Question/user support | ||
| * Invalid | ||
|
|
||
| ### Status | ||
| * Triaged | ||
| * Priority (low, medium, high) | ||
| * Waiting for user/waiting for contributor | ||
| * In progress | ||
| * Easy fix | ||
| * Backlog | ||
| * Duplicate | ||
| * Milestones (Github feature) | ||
|
|
||
| ## Additional Work | ||
| Update documentation: | ||
| * Update [contribute page](https://cordova.apache.org/contribute/). Links need to point to Github instead of Apache. | ||
| * Update [contributor guidelines](https://cordova.apache.org/contribute/contribute_guidelines.html). | ||
| * Update [committer workflow in cordova-coho](https://github.com/apache/cordova-coho/blob/master/docs/committer-workflow.md). | ||
| * Update [triaging doc in cordova-coho](https://github.com/apache/cordova-coho/blob/master/docs/jira-triage.md). This document will contain the list of labels (backlog, priority, etc). | ||
| * Update pull request templates (link to relevant issues). | ||
| * Add issue template. | ||
|
|
||
| ## Links | ||
| * https://issues.apache.org/jira/browse/CB-13157 | ||
| * https://cordova.apache.org/contribute/ | ||
| * https://cordova.apache.org/contribute/contribute_guidelines.html | ||
| * https://github.com/apache/cordova-coho/blob/master/docs/committer-workflow.md | ||
| * https://github.com/apache/cordova-coho/blob/master/docs/jira-triage.md | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should also update the GitHub pull request templates. They reference JIRA in them, so I think the suggested steps therein won't be relevant depending on the outcome of this discussion.
Android has an existing JIRA issue filed to tackle this: https://issues.apache.org/jira/browse/CB-12848
So does Browser: https://issues.apache.org/jira/browse/CB-13037
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Additionally, you should think about creating an Issue template per repo. Some examples I am aware of:
https://raw.githubusercontent.com/ionic-team/ionic-cli/master/.github/ISSUE_TEMPLATE.md
https://raw.githubusercontent.com/ionic-team/ionic-app-scripts/master/.github/ISSUE_TEMPLATE.md
https://raw.githubusercontent.com/ionic-team/ionic/master/.github/ISSUE_TEMPLATE.md
https://raw.githubusercontent.com/fastlane/fastlane/master/.github/ISSUE_TEMPLATE.md
(It might make sense to not rush this though, to see what actually happens and what has to be "directed" to make more sense and create better issues. Usually missing version numbers,
cordova requirementsor similar would make good candidates.)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@audreyso lets add these recommendations to this section of the PR.
Update pull request templates (link to relevant issues)
Add issue template