You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@accumulo.apache.org by kt...@apache.org on 2018/03/16 18:21:49 UTC
[accumulo-website] branch master updated: proposal for github
issues (#59)
This is an automated email from the ASF dual-hosted git repository.
kturner pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/accumulo-website.git
The following commit(s) were added to refs/heads/master by this push:
new 8734edf proposal for github issues (#59)
8734edf is described below
commit 8734edf8047b3fa8a7e8fdf01fb4fa4eaed6d7ae
Author: Keith Turner <ke...@deenlo.com>
AuthorDate: Fri Mar 16 14:21:46 2018 -0400
proposal for github issues (#59)
---
_posts/blog/2018-03-08-moving-to-github-issues.md | 21 +++++++
contributor/making-release.md | 10 ++-
pages/contact-us.md | 10 +--
pages/how-to-contribute.md | 77 +++++++++++++++++------
tour/index.md | 2 +-
5 files changed, 92 insertions(+), 28 deletions(-)
diff --git a/_posts/blog/2018-03-08-moving-to-github-issues.md b/_posts/blog/2018-03-08-moving-to-github-issues.md
new file mode 100644
index 0000000..15241e9
--- /dev/null
+++ b/_posts/blog/2018-03-08-moving-to-github-issues.md
@@ -0,0 +1,21 @@
+---
+title: "Migrating to GitHub Issues"
+---
+
+Apache Accumulo is migrating from [JIRA] to [GitHub issues][ghi]. The migration is starting with an initial plan, but it may change as the community uses it. For a description of the initial operating plan see the [issues section of How to Contribute](/how-to-contribute/#issues) and the [triaging issues section of Making a Release](/contributor/making-release#triage-issues).
+
+## Motivation
+
+Doing routine activities in less time is one motivation for the migration. Below are some examples.
+
+ * For GitHub a pull request is an issue. Therefore, creating an issue before a pull request is optional. Before the migration, an issue needed to be created in JIRA before creating a pull request. This was cumbersome for small changes.
+ * When browsing commits in GitHub, issue numbers can be clicked.
+ * Discussions on pull request can easily reference issues with simple markdown syntax.
+ * Commits can close issues if the commit message contains "fixes #xyz"
+
+## Migration
+
+There is no plan to migrate all existing issues in JIRA. The plan is to only migrate issues that someone is interested in or are actively being worked. Migration is done by linking the JIRA and GitHub issues to each other and then closing the JIRA issue. No new issues should be opened in JIRA. JIRA will eventually be transitioned to a read only state.
+
+[JIRA]: https://issues.apache.org/jira/browse/ACCUMULO
+[ghi]: https://github.com/apache/accumulo/issues
diff --git a/contributor/making-release.md b/contributor/making-release.md
index 7b85b92..78cdf53 100644
--- a/contributor/making-release.md
+++ b/contributor/making-release.md
@@ -22,6 +22,14 @@ There are number of things that are required before attempting to build a releas
Given all of this, it's recommended that you only attempt making a release from a GNU/Linux machine.
+## Triage issues.
+
+Before creating a release candidate, all open issues with a fix version of the
+release candidate should be triaged. During the transition from JIRA to GitHub
+issues, anyone doing triage will need to search for open issues in both
+locations. Searching in both locations is only necessary for branches that
+have not released since the transition started.
+
## Create the candidate
**TL;DR**
@@ -114,7 +122,7 @@ Fill out the [add release][addrelease] form to update the projects website.
After a successful vote, [this website][website-repo] needs to be updated with the new artifacts.
* Update downloads page
- * Create a post in `_posts/release/` containing release notes (ensure notes contain link to JIRA changes for that version)
+ * Create a post in `_posts/release/` containing release notes
* Remove previous bug-fix release (if applicable)
* Update doap_Accumulo.rdf
diff --git a/pages/contact-us.md b/pages/contact-us.md
index a9d978d..5a92d0c 100644
--- a/pages/contact-us.md
+++ b/pages/contact-us.md
@@ -10,8 +10,7 @@ Below are ways to get in touch with the Apache Accumulo community.
## Issues
-Accumulo uses [JIRA] to track bugs and new features. Before creating an issue, you will need to create
-an [Apache JIRA account][jira-signup].
+Accumulo uses GitHub issues to track bugs and new features. Visit [How to contribute](/how-to-contribute) for more information.
## Mailing Lists
@@ -25,7 +24,7 @@ follow discussions as they happen.
| **user** | General user questions, help, and announcements | [<span class="glyphicon glyphicon-search"/> Archive][U_A] | [<span class="glyphicon glyphicon-plus"/> Subscribe][U_SU] [<span class="glyphicon glyphicon-remove"/> Unsubscribe][U_UN] | [<span class="glyphicon glyphicon-envelope"/> Post][U_P] |
| **dev** | Contributor discussions and development activity | [<span class="glyphicon glyphicon-search"/> Archive][D_A] | [<span class="glyphicon glyphicon-plus"/> Subscribe][D_SU] [<span class="glyphicon glyphicon-remove"/> Unsubscribe][D_UN] | [<span class="glyphicon glyphicon-envelope"/> Post][D_P] |
| **commits** | Code changes | [<span class="glyphicon glyphicon-search"/> Archive][C_A] | [<span class="glyphicon glyphicon-plus"/> Subscribe][C_SU] [<span class="glyphicon glyphicon-remove"/> Unsubscribe][C_UN] | |
-| **notifications** | Automated notifications (JIRA, etc.) | [<span class="glyphicon glyphicon-search"/> Archive][N_A] | [<span class="glyphicon glyphicon-plus"/> Subscribe][N_SU] [<span class="glyphicon glyphicon-remove"/> Unsubscribe][N_UN] | |
+| **notifications** | Automated notifications (GitHub, etc.) | [<span class="glyphicon glyphicon-search"/> Archive][N_A] | [<span class="glyphicon glyphicon-plus"/> Subscribe][N_SU] [<span class="glyphicon glyphicon-remove"/> Unsubscribe][N_UN] | |
## IRC
@@ -39,11 +38,6 @@ Contributions to Apache Accumulo are welcome! If you are interested, read [how t
Attend Accumulo events such as [Accumulo Summit][summit] and meetups hosted by [Accumulo Users Group - DC VA MD][meetup-dc].
-[JIRA]: https://issues.apache.org/jira/browse/ACCUMULO
-[jira-signup]: https://issues.apache.org/jira/secure/Signup!default.jspa
-
-
-
[U_A]: https://lists.apache.org/list.html?user@accumulo.apache.org
{: .btn .btn-primary .btn-xs }
[U_SU]: mailto:user-subscribe@accumulo.apache.org
diff --git a/pages/how-to-contribute.md b/pages/how-to-contribute.md
index 0e0a562..45a3643 100644
--- a/pages/how-to-contribute.md
+++ b/pages/how-to-contribute.md
@@ -19,9 +19,43 @@ This document provides basic instructions for contributing to Accumulo. If you
## Issues
-Any contribution should have a corresponding issue. Accumulo uses [JIRA] for issue tracking. Before creating an issue,
-you will need to create an [Apache JIRA account][jira-signup]. If you need help finding an issue to work on, check out
-the [open issues labeled for newbies][newbie-issues] or [contact us][contact].
+Accumulo uses GitHub issues to track bugs and features. Each git repository
+has its own issues. In GitHub pull request are issues, therefore creating an
+issue before a pull request is optional. If unsure whether to start with an
+issue or pull request, then create an issue. If you need help finding an issue
+to work on, check out the [open issues labeled 'helpwanted'][helpwanted] or
+[contact us][contact].
+
+Accumulo previously used [JIRA], but is now transitioning to GitHub issues.
+All new issues should be opened using GitHub. When working an existing JIRA
+issue, please do the following :
+
+ * Open a new GitHub issue or pull request.
+ * Link the GitHub issue to the JIRA issue.
+ * Link the JIRA issue to the GitHub issue.
+ * Close the JIRA issue.
+
+Eventually JIRA will be transitioned to a read-only state for reference. For
+finding issues to work, there may still be
+[open issues labeled for newbies][newbie-issues] in JIRA.
+
+## Labels
+
+For pull request and issues, the following labels are used in the core
+repository. Consider an issue with labels `v1.9.3`, `v2.0.2`, and `bug`. If
+the issue is open, then its a bug that someone plans to fix in 1.9.3 and 2.0.2.
+If closed, then it was fixed in those versions.
+
+ Label | Description
+-------------|----------------------------------------------------------------------------
+ blocker | Indicates a release blocker that must be fixed in labeled versions.
+ bug |
+ duplicate |
+ enhancement |
+ vX.Y.Z | Fix version. The prefix `v` was chosen so that these labels sort last in the drop down list.
+
+Currently only Accumulo committers can set labels. If you think a label should
+be set, comment on the issue and someone will help.
## Repositories
@@ -29,24 +63,24 @@ Contributions can be made to the following repositories. While the general contr
described below, repositories have special instructions in their `CONTRIBUTING.md` file which can be
viewed by clicking on `contribute` in the Links column below.
-| Repository | Links | Description
-| ------------------------------- | -------- | -----------
-| [Accumulo][a] | [contribute][ac] | Core Project
-| [Accumulo Website][w] | [contribute][wc] | Source for this website
-| [Accumulo Examples][e] | [contribute][ec] | Accumulo example code
-| [Accumulo Testing][t] | [contribute][tc] | Accumulo test suites such as continuous ingest and random walk
-| [Accumulo Docker][d] | [contribute][dc] | Source for Accumulo Docker image
-| [Accumulo Wikisearch][s] | [contribute][sc] | Accumulo example application that indexes and queries Wikipedia data
+| Repository | Links | Description
+| ------------------------------- | ----------------------------- | -----------
+| [Accumulo][a] | [Contribute][ac] [Issues][ai] | Core Project
+| [Accumulo Website][w] | [Contribute][wc] [Issues][wi] | Source for this website
+| [Accumulo Examples][e] | [Contribute][ec] [Issues][ei] | Accumulo example code
+| [Accumulo Testing][t] | [Contribute][tc] [Issues][ti] | Accumulo test suites such as continuous ingest and random walk
+| [Accumulo Docker][d] | [Contribute][dc] [Issues][di] | Source for Accumulo Docker image
+| [Accumulo Wikisearch][s] | [Contribute][sc] [Issues][si] | Accumulo example application that indexes and queries Wikipedia data
## Contribution workflow
-1. Create an [Apache JIRA account][jira-signup] (for issue tracking) and [GitHub account][github-join] (for pull requests).
-1. Find an [issue][newbie-issues] to work on or create one that describes the work that you want to do.
+1. Create a [GitHub account][github-join] for issues and pull requests.
+1. Find an [issue][helpwanted] to work on or optionally create one that describes the work that you want to do.
1. [Fork] and [clone] the GitHub repository that you want to contribute to.
1. Create a branch in the local clone of your fork.
-```
+```
git checkout -b accumulo-4321
-```
+```
1. Do work and commit to your branch. You can reference [this link][messages] for a guide on how to write good commit log messages.
1. Ensure you works satisfies the guidelines laid out in the `CONTRIBUTING.md` file.
1. If needed, squash to the minimum number of commits. For help on squashing commits, see this [tutorial][squash-tutorial] or [StackOverflow answer][squash-stack].
@@ -62,8 +96,8 @@ viewed by clicking on `contribute` in the Links column below.
## Coding Guidelines
-* If a change needs to go into multiple branches of Accumulo, it should be merged into earlier branches then later branches.
-* Accumulo follows [semver] for its public API. Accumulo lists which packages are public API in its [README.md][accumulo-readme].
+* If a change needs to go into multiple branches of Accumulo, it should be merged into earlier branches then later branches.
+* Accumulo follows [semver] for its public API. Accumulo lists which packages are public API in its [README.md][accumulo-readme].
* Every file requires the ASF license header as described in [ASF Source Header][srcheaders].
* Remove all trailing whitespaces. Eclipse users can use Source→Cleanup option to accomplish this.
* Use 2 space indents and never use tabs!
@@ -96,7 +130,7 @@ developers use [IntelliJ][intellij] or [Eclipse][eclipse]. Below are some basic
```
1. [Import][eclipse-import] the repository as a Maven project into Eclipse
1. (Optional) Download and import Eclipse formatting and style guides from Accumulo's [contrib][accumulo-contrib] directory
- * Import Formatter: `Preferences` > `Java` > `Code Style` > `Formatter` and import the `Eclipse-Accumulo-Codestyle.xml` downloaded in the previous step.
+ * Import Formatter: `Preferences` > `Java` > `Code Style` > `Formatter` and import the `Eclipse-Accumulo-Codestyle.xml` downloaded in the previous step.
* Import Template: `Preferences` > `Java` > `Code Style` > `Code Templates` and import the `Eclipse-Accumulo-Template.xml`. Make sure to check the "Automatically add comments" box. This template adds the ASF header and so on for new code.
## Helpful Links
@@ -107,19 +141,26 @@ developers use [IntelliJ][intellij] or [Eclipse][eclipse]. Below are some basic
For more details, see the [contributor guide](/contributors-guide/).
[newbie-issues]: https://s.apache.org/newbie_accumulo_tickets
+[helpwanted]: https://github.com/search?utf8=%E2%9C%93&q=state%3Aopen+label%3A%22help+wanted%22+repo%3Aapache%2Faccumulo+repo%3Aapache%2Faccumulo-website+repo%3Aapache%2Faccumulo-examples+repo%3Aapache%2Faccumulo-testing&type=
[contact]: /contact-us/
[a]: https://github.com/apache/accumulo
[ac]: https://github.com/apache/accumulo/blob/master/CONTRIBUTING.md
+[ai]: https://github.com/apache/accumulo/issues
[w]: https://github.com/apache/accumulo-website
[wc]: https://github.com/apache/accumulo-website/blob/master/CONTRIBUTING.md
+[wi]: https://github.com/apache/accumulo-website/issues
[e]: https://github.com/apache/accumulo-examples
[ec]: https://github.com/apache/accumulo-examples/blob/master/CONTRIBUTING.md
+[ei]: https://github.com/apache/accumulo-examples/issues
[t]: https://github.com/apache/accumulo-testing
[tc]: https://github.com/apache/accumulo-testing/blob/master/CONTRIBUTING.md
+[ti]: https://github.com/apache/accumulo-testing/issues
[d]: https://github.com/apache/accumulo-docker
[dc]: https://github.com/apache/accumulo-docker/blob/master/CONTRIBUTING.md
+[di]: https://github.com/apache/accumulo-docker/issues
[s]: https://github.com/apache/accumulo-wikisearch
[sc]: https://github.com/apache/accumulo-wikisearch/blob/master/CONTRIBUTING.md
+[si]: https://github.com/apache/accumulo-wikisearch/issues
[jira-signup]: https://issues.apache.org/jira/secure/Signup!default.jspa
[github-join]: https://github.com/join
[manual]: {{ site.baseurl }}/{{ site.latest_minor_release }}/accumulo_user_manual.html
diff --git a/tour/index.md b/tour/index.md
index 4e9224a..9f01ab0 100644
--- a/tour/index.md
+++ b/tour/index.md
@@ -25,4 +25,4 @@ or [create an issue][issue].
{% endfor %}
[mlist]: /contact-us/#mailing-lists
-[issue]: https://issues.apache.org/jira/projects/ACCUMULO
+[issue]: https://github.com/apache/accumulo-website/issues
--
To stop receiving notification emails like this one, please contact
kturner@apache.org.