[2/2] accumulo-website git commit: Jekyll build from master:8d90110
Jekyll build from master:8d90110 Updated release guide with changes to Accumulo documentation Project: http://git-wip-us.apache.org/repos/asf/accumulo-website/repo Commit: http://git-wip-us.apache.org/repos/asf/accumulo-website/commit/a0a66d3e Tree: http://git-wip-us.apache.org/repos/asf/accumulo-website/tree/a0a66d3e Diff: http://git-wip-us.apache.org/repos/asf/accumulo-website/diff/a0a66d3e Branch: refs/heads/asf-site Commit: a0a66d3ea1c6634fc6416400044f774471eedd2e Parents: f4cf7bf Author: Mike Walch Authored: Tue Jun 6 17:27:49 2017 -0400 Committer: Mike Walch Committed: Tue Jun 6 17:27:49 2017 -0400 -- contributor/making-release.html | 36 ++-- feed.xml| 4 ++-- 2 files changed, 36 insertions(+), 4 deletions(-) -- http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/a0a66d3e/contributor/making-release.html -- diff --git a/contributor/making-release.html b/contributor/making-release.html index 787f443..6a24352 100644 --- a/contributor/making-release.html +++ b/contributor/making-release.html @@ -255,18 +255,50 @@ automatically. Fill out the https://reporter.apache.org/addrelease?accumulo";>add release form to update the projects website. -Update the Website +Update the Accumulo project website After a successful vote, this website needs to be updated with the new artifacts. - Copy Accumulo User Manual (HTML version exists in >=1.7.0) Update downloads page Create a post in _posts/release/ containing release notes (ensure notes contain link to JIRA changes for that version) Remove previous bug-fix release (if applicable) Update doap_Accumulo.rdf +Documentation + +For 2.x minor releases, follow the steps below: + + + +Create a new documentation collection for the new minor release (i.e 2.0) using the unreleased collection. Avoid using a dot . in directory name: + + cp -r _docs-unreleased _docs-2-0 + + + + +Create a new doc layout using the unreleased layout. Update the reference to site.docs-unreleased to site.docs-2-0 (if making 2.0 release): + + cp _layouts/docs-unreleased.html _layouts/docs-2.0.html + vim _layouts/docs-2.0.html + + + + +Point Jekyll to the new documentation collection by modifying collections and defaults in _config.yml. Follow what was done for previous +releases. + + + +Once a collection is created for a 2.x minor release, developers can make documentation updates like normal website updates. + +For 2.x bugfix releases, nothing needs to be done. + +For 1.x minor & bugfix releases, copy and commit the accumulo_user_manual.html generated for release to the 1.x/ directory in +Accumulo website repo. + Javadocs Javadocs are easy to update. Using the latest JDK7 or later (at least JDK 7u21 http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/a0a66d3e/feed.xml -- diff --git a/feed.xml b/feed.xml index 898b9c3..ee22e5e 100644 --- a/feed.xml +++ b/feed.xml @@ -6,8 +6,8 @@ https://accumulo.apache.org/ https://accumulo.apache.org/feed.xml"; rel="self" type="application/rss+xml"/> -Tue, 06 Jun 2017 16:12:23 -0400 -Tue, 06 Jun 2017 16:12:23 -0400 +Tue, 06 Jun 2017 17:27:41 -0400 +Tue, 06 Jun 2017 17:27:41 -0400 Jekyll v3.3.1
[1/2] accumulo-website git commit: Updated release guide with changes to Accumulo documentation
Repository: accumulo-website Updated Branches: refs/heads/asf-site f4cf7bfb1 -> a0a66d3ea refs/heads/master a4540ce7f -> 8d90110ea Updated release guide with changes to Accumulo documentation Project: http://git-wip-us.apache.org/repos/asf/accumulo-website/repo Commit: http://git-wip-us.apache.org/repos/asf/accumulo-website/commit/8d90110e Tree: http://git-wip-us.apache.org/repos/asf/accumulo-website/tree/8d90110e Diff: http://git-wip-us.apache.org/repos/asf/accumulo-website/diff/8d90110e Branch: refs/heads/master Commit: 8d90110ea901eafb315c385ffa1262e9dc907d99 Parents: a4540ce Author: Mike Walch Authored: Tue Jun 6 17:27:23 2017 -0400 Committer: Mike Walch Committed: Tue Jun 6 17:27:23 2017 -0400 -- contributor/making-release.md | 26 -- 1 file changed, 24 insertions(+), 2 deletions(-) -- http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/8d90110e/contributor/making-release.md -- diff --git a/contributor/making-release.md b/contributor/making-release.md index 41a3e85..1c49c7c 100644 --- a/contributor/making-release.md +++ b/contributor/making-release.md @@ -109,16 +109,38 @@ automatically. Fill out the [add release][addrelease] form to update the projects website. -## Update the Website +## Update the Accumulo project website After a successful vote, this website needs to be updated with the new artifacts. - * Copy Accumulo User Manual (HTML version exists in >=1.7.0) * Update downloads page * Create a post in `_posts/release/` containing release notes (ensure notes contain link to JIRA changes for that version) * Remove previous bug-fix release (if applicable) * Update doap_Accumulo.rdf +### Documentation + +**For 2.x minor releases,** follow the steps below: + +1. Create a new documentation collection for the new minor release (i.e `2.0`) using the unreleased collection. Avoid using a dot `.` in directory name: + +cp -r _docs-unreleased _docs-2-0 + +2. Create a new doc layout using the unreleased layout. Update the reference to `site.docs-unreleased` to `site.docs-2-0` (if making 2.0 release): + +cp _layouts/docs-unreleased.html _layouts/docs-2.0.html +vim _layouts/docs-2.0.html + +3. Point Jekyll to the new documentation collection by modifying `collections` and `defaults` in `_config.yml`. Follow what was done for previous + releases. + +Once a collection is created for a 2.x minor release, developers can make documentation updates like normal website updates. + +**For 2.x bugfix releases,** nothing needs to be done. + +**For 1.x minor & bugfix releases,** copy and commit the `accumulo_user_manual.html` generated for release to the `1.x/` directory in +Accumulo website repo. + ### Javadocs Javadocs are easy to update. Using the latest JDK7 or later (at least JDK 7u21
[2/2] accumulo-website git commit: Jekyll build from master:a4540ce
Jekyll build from master:a4540ce Added 'latest' redirects for each documentation page * Enables links from external sites to 'latest' documentation page * Redirects will start working when 2.0 is released Project: http://git-wip-us.apache.org/repos/asf/accumulo-website/repo Commit: http://git-wip-us.apache.org/repos/asf/accumulo-website/commit/f4cf7bfb Tree: http://git-wip-us.apache.org/repos/asf/accumulo-website/tree/f4cf7bfb Diff: http://git-wip-us.apache.org/repos/asf/accumulo-website/diff/f4cf7bfb Branch: refs/heads/asf-site Commit: f4cf7bfb13e5d9056a2d5be1f05958bfc9561a7b Parents: d5fc9d3 Author: Mike Walch Authored: Tue Jun 6 16:12:31 2017 -0400 Committer: Mike Walch Committed: Tue Jun 6 16:12:31 2017 -0400 -- docs/latest/administration/configuration-management.html | 10 ++ docs/latest/administration/configuration-properties.html | 10 ++ docs/latest/administration/fate.html | 10 ++ docs/latest/administration/in-depth-install.html | 10 ++ docs/latest/administration/kerberos.html | 10 ++ docs/latest/administration/monitoring-metrics.html | 10 ++ docs/latest/administration/multivolume.html | 10 ++ docs/latest/administration/replication.html | 10 ++ docs/latest/administration/ssl.html | 10 ++ docs/latest/administration/tracing.html | 10 ++ docs/latest/development/development_tools.html | 10 ++ docs/latest/development/high_speed_ingest.html | 10 ++ docs/latest/development/iterators.html | 10 ++ docs/latest/development/mapreduce.html | 10 ++ docs/latest/development/proxy.html | 10 ++ docs/latest/development/sampling.html| 10 ++ docs/latest/development/security.html| 10 ++ docs/latest/development/summaries.html | 10 ++ docs/latest/getting-started/clients.html | 10 ++ docs/latest/getting-started/design.html | 10 ++ docs/latest/getting-started/quick-install.html | 10 ++ docs/latest/getting-started/shell.html | 10 ++ docs/latest/getting-started/table_configuration.html | 10 ++ docs/latest/getting-started/table_design.html| 10 ++ docs/latest/index.html | 10 ++ docs/latest/troubleshooting/advanced.html| 10 ++ docs/latest/troubleshooting/basic.html | 10 ++ docs/latest/troubleshooting/system-metadata-tables.html | 10 ++ docs/latest/troubleshooting/tools.html | 10 ++ feed.xml | 4 ++-- 30 files changed, 292 insertions(+), 2 deletions(-) -- http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/f4cf7bfb/docs/latest/administration/configuration-management.html -- diff --git a/docs/latest/administration/configuration-management.html b/docs/latest/administration/configuration-management.html new file mode 100644 index 000..5417490 --- /dev/null +++ b/docs/latest/administration/configuration-management.html @@ -0,0 +1,10 @@ + + + +Redirecting⦠+ + +Redirecting⦠+Click here if you are not redirected. +location="/docs/1.8/administration/configuration-management" + http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/f4cf7bfb/docs/latest/administration/configuration-properties.html -- diff --git a/docs/latest/administration/configuration-properties.html b/docs/latest/administration/configuration-properties.html new file mode 100644 index 000..97d0f6f --- /dev/null +++ b/docs/latest/administration/configuration-properties.html @@ -0,0 +1,10 @@ + + + +Redirecting⦠+ + +Redirecting⦠+Click here if you are not redirected. +location="/docs/1.8/administration/configuration-properties" + http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/f4cf7bfb/docs/latest/administration/fate.html -- diff --git a/docs/latest/administration/fate.html b/docs/latest/administration/fate.html new file mode 100644 index 000..9e2091e --- /dev/null +++ b/docs/latest/administration/fate.html @@ -0,0 +1,10 @@ + + + +Redirecting⦠+ + +Redirecting⦠+Click here if you are not redirected. +location="/docs/1.8/administration/fate" + http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/f4cf7bfb/docs/latest/administration/in-depth-install.html
[1/2] accumulo-website git commit: Added 'latest' redirects for each documentation page
Repository: accumulo-website
Updated Branches:
refs/heads/asf-site d5fc9d3d4 -> f4cf7bfb1
refs/heads/master 2386e76b2 -> a4540ce7f
Added 'latest' redirects for each documentation page
* Enables links from external sites to 'latest' documentation page
* Redirects will start working when 2.0 is released
Project: http://git-wip-us.apache.org/repos/asf/accumulo-website/repo
Commit: http://git-wip-us.apache.org/repos/asf/accumulo-website/commit/a4540ce7
Tree: http://git-wip-us.apache.org/repos/asf/accumulo-website/tree/a4540ce7
Diff: http://git-wip-us.apache.org/repos/asf/accumulo-website/diff/a4540ce7
Branch: refs/heads/master
Commit: a4540ce7f8f5c1acb4af58f1c8113c0e6bbdfcb6
Parents: 2386e76
Author: Mike Walch
Authored: Tue Jun 6 15:51:56 2017 -0400
Committer: Mike Walch
Committed: Tue Jun 6 16:09:52 2017 -0400
--
docs/latest/administration/configuration-management.md | 6 ++
docs/latest/administration/configuration-properties.md | 6 ++
docs/latest/administration/fate.md | 6 ++
docs/latest/administration/in-depth-install.md | 6 ++
docs/latest/administration/kerberos.md | 6 ++
docs/latest/administration/monitoring-metrics.md | 6 ++
docs/latest/administration/multivolume.md | 6 ++
docs/latest/administration/replication.md | 6 ++
docs/latest/administration/ssl.md | 6 ++
docs/latest/administration/tracing.md | 6 ++
docs/latest/development/development_tools.md | 6 ++
docs/latest/development/high_speed_ingest.md | 6 ++
docs/latest/development/iterators.md | 6 ++
docs/latest/development/mapreduce.md | 6 ++
docs/latest/development/proxy.md | 6 ++
docs/latest/development/sampling.md| 6 ++
docs/latest/development/security.md| 6 ++
docs/latest/development/summaries.md | 6 ++
docs/latest/getting-started/clients.md | 6 ++
docs/latest/getting-started/design.md | 6 ++
docs/latest/getting-started/quick-install.md | 6 ++
docs/latest/getting-started/shell.md | 6 ++
docs/latest/getting-started/table_configuration.md | 6 ++
docs/latest/getting-started/table_design.md| 6 ++
docs/latest/index.md | 6 ++
docs/latest/troubleshooting/advanced.md| 6 ++
docs/latest/troubleshooting/basic.md | 6 ++
docs/latest/troubleshooting/system-metadata-tables.md | 6 ++
docs/latest/troubleshooting/tools.md | 6 ++
29 files changed, 174 insertions(+)
--
http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/a4540ce7/docs/latest/administration/configuration-management.md
--
diff --git a/docs/latest/administration/configuration-management.md
b/docs/latest/administration/configuration-management.md
new file mode 100644
index 000..530131b
--- /dev/null
+++ b/docs/latest/administration/configuration-management.md
@@ -0,0 +1,6 @@
+---
+title: Redirect to latest documentation
+redirect_to: "{{ site.baseurl }}/docs/{{ site.latest_minor_release
}}/administration/configuration-management"
+---
+
+This page redirects to the latest documentation
http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/a4540ce7/docs/latest/administration/configuration-properties.md
--
diff --git a/docs/latest/administration/configuration-properties.md
b/docs/latest/administration/configuration-properties.md
new file mode 100644
index 000..820fc6c
--- /dev/null
+++ b/docs/latest/administration/configuration-properties.md
@@ -0,0 +1,6 @@
+---
+title: Redirect to latest documentation
+redirect_to: "{{ site.baseurl }}/docs/{{ site.latest_minor_release
}}/administration/configuration-properties"
+---
+
+This page redirects to the latest documentation
http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/a4540ce7/docs/latest/administration/fate.md
--
diff --git a/docs/latest/administration/fate.md
b/docs/latest/administration/fate.md
new file mode 100644
index 000..765aaf5
--- /dev/null
+++ b/docs/latest/administration/fate.md
@@ -0,0 +1,6 @@
+---
+title: Redirect to latest documentation
+redirect_to: "{{ site.baseurl }}/docs/{{ site.latest_minor_release
}}/administration/fate"
+---
+
+This page redirects to the latest documentation
http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/a4540ce7/docs/latest/administration/in-depth-install.md
---
accumulo git commit: ACCUMULO-4647: Added contributor guide
Repository: accumulo Updated Branches: refs/heads/master 66178ad87 -> 39efb48d0 ACCUMULO-4647: Added contributor guide Project: http://git-wip-us.apache.org/repos/asf/accumulo/repo Commit: http://git-wip-us.apache.org/repos/asf/accumulo/commit/39efb48d Tree: http://git-wip-us.apache.org/repos/asf/accumulo/tree/39efb48d Diff: http://git-wip-us.apache.org/repos/asf/accumulo/diff/39efb48d Branch: refs/heads/master Commit: 39efb48d06e4f3955726a1b8fb401fdc2bcfb5d9 Parents: 66178ad Author: Dave Marion Authored: Tue Jun 6 12:13:09 2017 -0400 Committer: Dave Marion Committed: Tue Jun 6 12:13:09 2017 -0400 -- CONTRIBUTING.md | 43 +++ 1 file changed, 43 insertions(+) -- http://git-wip-us.apache.org/repos/asf/accumulo/blob/39efb48d/CONTRIBUTING.md -- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000..9f52bdb --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,43 @@ + + +# Contributors Guide + + If you believe that you have found a bug, please search for an existing [issue](https://issues.apache.org/jira/browse/accumulo) to see if it has already been reported. If you would like to add a new feature to Accumulo, please send an email with your idea to the [dev](mailto:d...@accumulo.apache.org) mail list. If it's appropriate, then we will create a ticket and assign it to you. + +## Development + +- See the [Developer's Guide](https://accumulo.apache.org/contributor/source) for information regarding common build commands, IDE setup and more. +- Ensure that your work targets the correct branch +- Add / update unit and integration tests + +## Patch Submission + +- Ensure that Accumulo builds cleanly before submiting your patch using the command: `mvn clean verify -DskipITs` +- Before submission please squash your commits using a message that starts with the JIRA issue number and a description of the changes. +- Patches should be submitted in the form of Pull Requests to the Apache Accumulo GitHub [repository](https://github.com/apache/accumulo/) or to the [Review Board](https://reviews.apache.org) accumulo repository. + +## Review + +- We welcome reviews from anyone. Any committer can approve and merge the changes. +- Reviewers will be looking for things like threading issues, performance implications, API design, etc. +- Reviewers will likely ask questions to better understand your change. +- Reviewers will make comments about changes to your patch: +- MUST means that the change is required +- SHOULD means that the change is suggested, further discussion on the subject may be required +- COULD means that the change is optional +
[accumulo] Git Push Summary
Repository: accumulo Updated Branches: refs/heads/ACCUMULO-4647 [deleted] 9e864befc
accumulo git commit: ACCUMULO-4647: latest changes
Repository: accumulo Updated Branches: refs/heads/ACCUMULO-4647 32eaf3545 -> 9e864befc ACCUMULO-4647: latest changes Project: http://git-wip-us.apache.org/repos/asf/accumulo/repo Commit: http://git-wip-us.apache.org/repos/asf/accumulo/commit/9e864bef Tree: http://git-wip-us.apache.org/repos/asf/accumulo/tree/9e864bef Diff: http://git-wip-us.apache.org/repos/asf/accumulo/diff/9e864bef Branch: refs/heads/ACCUMULO-4647 Commit: 9e864befcd74876905697644293e21679c0e4a56 Parents: 32eaf35 Author: Dave Marion Authored: Tue Jun 6 11:45:58 2017 -0400 Committer: Dave Marion Committed: Tue Jun 6 11:45:58 2017 -0400 -- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) -- http://git-wip-us.apache.org/repos/asf/accumulo/blob/9e864bef/CONTRIBUTING.md -- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fd4d7e6..9f52bdb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,13 +27,13 @@ limitations under the License. ## Patch Submission -- Ensure that Accumulo builds cleanly before submiting your patch using the command: `mvn clean verify` +- Ensure that Accumulo builds cleanly before submiting your patch using the command: `mvn clean verify -DskipITs` - Before submission please squash your commits using a message that starts with the JIRA issue number and a description of the changes. - Patches should be submitted in the form of Pull Requests to the Apache Accumulo GitHub [repository](https://github.com/apache/accumulo/) or to the [Review Board](https://reviews.apache.org) accumulo repository. ## Review -- While everyone is welcome to review patches, at least one committer needs to review and approve your patch. +- We welcome reviews from anyone. Any committer can approve and merge the changes. - Reviewers will be looking for things like threading issues, performance implications, API design, etc. - Reviewers will likely ask questions to better understand your change. - Reviewers will make comments about changes to your patch:
accumulo git commit: ACCUMULO-4647 - changes from review comments
Repository: accumulo Updated Branches: refs/heads/ACCUMULO-4647 8b6e8330c -> 32eaf3545 ACCUMULO-4647 - changes from review comments Project: http://git-wip-us.apache.org/repos/asf/accumulo/repo Commit: http://git-wip-us.apache.org/repos/asf/accumulo/commit/32eaf354 Tree: http://git-wip-us.apache.org/repos/asf/accumulo/tree/32eaf354 Diff: http://git-wip-us.apache.org/repos/asf/accumulo/diff/32eaf354 Branch: refs/heads/ACCUMULO-4647 Commit: 32eaf35457f34fc450c3be74c15e96b967b27e39 Parents: 8b6e833 Author: Dave Marion Authored: Tue Jun 6 11:01:48 2017 -0400 Committer: Dave Marion Committed: Tue Jun 6 11:01:48 2017 -0400 -- CONTRIBUTING.md | 30 -- pom.xml | 1 - 2 files changed, 24 insertions(+), 7 deletions(-) -- http://git-wip-us.apache.org/repos/asf/accumulo/blob/32eaf354/CONTRIBUTING.md -- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b32729e..fd4d7e6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,23 +1,41 @@ + + # Contributors Guide - If you believe that you have found a bug, please search for an existing [issue](https://issues.apache.org/jira/browse/accumulo) to see if it has already been reported. If you would like to add a new feature to Accumulo, please send an email with your idea to the [user](mailto:u...@accumulo.apache.org) mail list. If it's appropriate, then we will create a ticket and assign it to you. + If you believe that you have found a bug, please search for an existing [issue](https://issues.apache.org/jira/browse/accumulo) to see if it has already been reported. If you would like to add a new feature to Accumulo, please send an email with your idea to the [dev](mailto:d...@accumulo.apache.org) mail list. If it's appropriate, then we will create a ticket and assign it to you. ## Development +- See the [Developer's Guide](https://accumulo.apache.org/contributor/source) for information regarding common build commands, IDE setup and more. - Ensure that your work targets the correct branch - Add / update unit and integration tests -- Ensure that Accumulo builds cleanly using the command: `mvn clean verify` ## Patch Submission -- Before submission please squash your commits using a message that contains the JIRA issue number and a description of the changes. +- Ensure that Accumulo builds cleanly before submiting your patch using the command: `mvn clean verify` +- Before submission please squash your commits using a message that starts with the JIRA issue number and a description of the changes. - Patches should be submitted in the form of Pull Requests to the Apache Accumulo GitHub [repository](https://github.com/apache/accumulo/) or to the [Review Board](https://reviews.apache.org) accumulo repository. ## Review -- One or more committers will review your patch. -- They will be looking for things like threading issues, performance implications, API design, etc. -- Reviewers will likely ask questions to better understand your change - be prepared to answer them. +- While everyone is welcome to review patches, at least one committer needs to review and approve your patch. +- Reviewers will be looking for things like threading issues, performance implications, API design, etc. +- Reviewers will likely ask questions to better understand your change. - Reviewers will make comments about changes to your patch: - MUST means that the change is required - SHOULD means that the change is suggested, further discussion on the subject may be required http://git-wip-us.apache.org/repos/asf/accumulo/blob/32eaf354/pom.xml -- diff --git a/pom.xml b/pom.xml index f4c067e..69b4e77 100644 --- a/pom.xml +++ b/pom.xml @@ -832,7 +832,6 @@ nbproject/** nb-configuration.xml nbactions.xml - CONTRIBUTING.md
accumulo git commit: ACCUMULO-4647 - start of contributor guide
Repository: accumulo Updated Branches: refs/heads/ACCUMULO-4647 [created] 8b6e8330c ACCUMULO-4647 - start of contributor guide Project: http://git-wip-us.apache.org/repos/asf/accumulo/repo Commit: http://git-wip-us.apache.org/repos/asf/accumulo/commit/8b6e8330 Tree: http://git-wip-us.apache.org/repos/asf/accumulo/tree/8b6e8330 Diff: http://git-wip-us.apache.org/repos/asf/accumulo/diff/8b6e8330 Branch: refs/heads/ACCUMULO-4647 Commit: 8b6e8330cc17216f40198f3d22453b5a8405ea1f Parents: 66178ad Author: Dave Marion Authored: Tue Jun 6 09:00:43 2017 -0400 Committer: Dave Marion Committed: Tue Jun 6 09:00:43 2017 -0400 -- CONTRIBUTING.md | 25 + pom.xml | 1 + 2 files changed, 26 insertions(+) -- http://git-wip-us.apache.org/repos/asf/accumulo/blob/8b6e8330/CONTRIBUTING.md -- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000..b32729e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Contributors Guide + + If you believe that you have found a bug, please search for an existing [issue](https://issues.apache.org/jira/browse/accumulo) to see if it has already been reported. If you would like to add a new feature to Accumulo, please send an email with your idea to the [user](mailto:u...@accumulo.apache.org) mail list. If it's appropriate, then we will create a ticket and assign it to you. + +## Development + +- Ensure that your work targets the correct branch +- Add / update unit and integration tests +- Ensure that Accumulo builds cleanly using the command: `mvn clean verify` + +## Patch Submission + +- Before submission please squash your commits using a message that contains the JIRA issue number and a description of the changes. +- Patches should be submitted in the form of Pull Requests to the Apache Accumulo GitHub [repository](https://github.com/apache/accumulo/) or to the [Review Board](https://reviews.apache.org) accumulo repository. + +## Review + +- One or more committers will review your patch. +- They will be looking for things like threading issues, performance implications, API design, etc. +- Reviewers will likely ask questions to better understand your change - be prepared to answer them. +- Reviewers will make comments about changes to your patch: +- MUST means that the change is required +- SHOULD means that the change is suggested, further discussion on the subject may be required +- COULD means that the change is optional + http://git-wip-us.apache.org/repos/asf/accumulo/blob/8b6e8330/pom.xml -- diff --git a/pom.xml b/pom.xml index 69b4e77..f4c067e 100644 --- a/pom.xml +++ b/pom.xml @@ -832,6 +832,7 @@ nbproject/** nb-configuration.xml nbactions.xml + CONTRIBUTING.md
