[GitHub] jmark99 commented on a change in pull request #37: Accumulo 4714 Create landing page for new developers
jmark99 commented on a change in pull request #37: Accumulo 4714 Create landing page for new developers URL: https://github.com/apache/accumulo-website/pull/37#discussion_r150912626 ## File path: pages/how-to-contribute.md ## @@ -0,0 +1,151 @@ +--- +title: How To Contribute +permalink: /how-to-contribute/ +redirect_from: /contributor/ +--- + +Contributions are welcome to all Apache Accumulo repositories. While most contributions are code, +there are other ways to contribute to Accumulo: + +* answer questions on mailing lists +* review pull requests +* verify and test new releases +* update the Accumulo website and documentation + +Contributions are reviewed (via GitHub pull requests) by +the community before being merged by a committer. + +This document provides basic instructions for contributing to Accumulo. If you are looking for more information, check out the more comprehensive [contributor guide](/contributors-guide/). + +## 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]. + +## Repositories + +Contributions can be made to the following repositories. While the general contribution workflow is +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 + +## 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. [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 +to write good commit log messages in git. Review comment: @keith-turner, thanks for catching that. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] jmark99 commented on a change in pull request #37: Accumulo 4714 Create landing page for new developers
jmark99 commented on a change in pull request #37: Accumulo 4714 Create landing page for new developers URL: https://github.com/apache/accumulo-website/pull/37#discussion_r150639612 ## File path: pages/how-to-contribute.md ## @@ -0,0 +1,149 @@ +--- +title: How To Contribute +permalink: /how-to-contribute/ +redirect_from: /contributor/ +--- + +Contributions are welcome to all Apache Accumulo repositories. While most contributions are code, +there are other ways to contribute to Accumulo: + +* answer questions on mailing lists +* review pull requests +* verify and test new releases +* update the Accumulo website and documentation + +Contributions are reviewed (via GitHub pull requests) by +the community before being merged by a committer. + +This document provides basic instructions for contributing to Accumulo. If you are looking for more information, check out the more comprehensive [contributor guide](/contributors-guide/). + +## 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]. + +## Repositories + +Contributions can be made to the following repositories. While the general contribution workflow is +described below, repositories have special instructions in their `CONTRIBUTING.md` file which can be +viewed by clicking on the `C` in the Links column below. Review comment: Never mind, I see that there will be a new CONTRIBUTING.md when the PR gets pushed. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] jmark99 commented on a change in pull request #37: Accumulo 4714 Create landing page for new developers
jmark99 commented on a change in pull request #37: Accumulo 4714 Create landing page for new developers URL: https://github.com/apache/accumulo-website/pull/37#discussion_r150640326 ## File path: pages/how-to-contribute.md ## @@ -0,0 +1,149 @@ +--- +title: How To Contribute +permalink: /how-to-contribute/ +redirect_from: /contributor/ +--- + +Contributions are welcome to all Apache Accumulo repositories. While most contributions are code, +there are other ways to contribute to Accumulo: + +* answer questions on mailing lists +* review pull requests +* verify and test new releases +* update the Accumulo website and documentation + +Contributions are reviewed (via GitHub pull requests) by +the community before being merged by a committer. + +This document provides basic instructions for contributing to Accumulo. If you are looking for more information, check out the more comprehensive [contributor guide](/contributors-guide/). + +## 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]. + +## Repositories + +Contributions can be made to the following repositories. While the general contribution workflow is +described below, repositories have special instructions in their `CONTRIBUTING.md` file which can be +viewed by clicking on the `C` in the Links column below. Review comment: Pushed the change up to Github This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] jmark99 commented on a change in pull request #37: Accumulo 4714 Create landing page for new developers
jmark99 commented on a change in pull request #37: Accumulo 4714 Create landing page for new developers URL: https://github.com/apache/accumulo-website/pull/37#discussion_r150639612 ## File path: pages/how-to-contribute.md ## @@ -0,0 +1,149 @@ +--- +title: How To Contribute +permalink: /how-to-contribute/ +redirect_from: /contributor/ +--- + +Contributions are welcome to all Apache Accumulo repositories. While most contributions are code, +there are other ways to contribute to Accumulo: + +* answer questions on mailing lists +* review pull requests +* verify and test new releases +* update the Accumulo website and documentation + +Contributions are reviewed (via GitHub pull requests) by +the community before being merged by a committer. + +This document provides basic instructions for contributing to Accumulo. If you are looking for more information, check out the more comprehensive [contributor guide](/contributors-guide/). + +## 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]. + +## Repositories + +Contributions can be made to the following repositories. While the general contribution workflow is +described below, repositories have special instructions in their `CONTRIBUTING.md` file which can be +viewed by clicking on the `C` in the Links column below. Review comment: Never mind, I see that there will be a new CONTRIBUTING.md when the PR gets pushed. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] jmark99 commented on a change in pull request #37: Accumulo 4714 Create landing page for new developers
jmark99 commented on a change in pull request #37: Accumulo 4714 Create landing page for new developers URL: https://github.com/apache/accumulo-website/pull/37#discussion_r150637229 ## File path: pages/how-to-contribute.md ## @@ -0,0 +1,149 @@ +--- +title: How To Contribute +permalink: /how-to-contribute/ +redirect_from: /contributor/ +--- + +Contributions are welcome to all Apache Accumulo repositories. While most contributions are code, +there are other ways to contribute to Accumulo: + +* answer questions on mailing lists +* review pull requests +* verify and test new releases +* update the Accumulo website and documentation + +Contributions are reviewed (via GitHub pull requests) by +the community before being merged by a committer. + +This document provides basic instructions for contributing to Accumulo. If you are looking for more information, check out the more comprehensive [contributor guide](/contributors-guide/). + +## 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]. + +## Repositories + +Contributions can be made to the following repositories. While the general contribution workflow is +described below, repositories have special instructions in their `CONTRIBUTING.md` file which can be +viewed by clicking on the `C` in the Links column below. Review comment: I'll update the links to say 'contribute' . But when testing the links just now I noticed that the accumulo-website link is broken. Going over to the accumulo-website github page I see that there is not a CONTRIBUTING.md file. Has there been one in the past? And if now, what should this link connect to? This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] jmark99 commented on a change in pull request #37: Accumulo 4714 Create landing page for new developers
jmark99 commented on a change in pull request #37: Accumulo 4714 Create landing page for new developers URL: https://github.com/apache/accumulo-website/pull/37#discussion_r150614613 ## File path: contributor/contributors-guide.md ## @@ -0,0 +1,649 @@ +--- +title: Contributor Guide +permalink: /contributors-guide/ +--- + +This page contains resources and documentation of interest to current and potential contributors to the Accumulo project. Any documentation that is helpful to Accumulo users should go in the [Accumulo User Manual][manual]. + +If your are interested in quickly getting an Accumulo instance up and running, see the Accumulo Quickstart guides [(1.x)][quickstart1x]/[(2.x)][quickstart2x] or refer to the [Uno] project on Github. + +- [How to contribute to Apache Accumulo][1] +- [Project Resources][2] + - [GitHub][3] + - [JIRA][4] + - [Jenkins/TravisCI][5] +- [Create a Ticket for Bugs or New Features][6] +- [Building Accumulo from Source][7] + - [Installing Apache Thrift][29] + - [Checking out from Git][8] + - [Running a Build][9] +- [Providing a contribution][10] + - [Proposed Workflow][11] + - [The Implementation][12] +- [Contributors][13] +- [Developers][14] + - [Primary Development][15] + - [Reviewing Contributor Changes][16] + - [Submit Contribution via Patch][17] + - [Submit Contribution via Pull Request][18] + - [Feature Branches][19] + - [Changes Which Affect Multiple-Versions (a.k.a Merging)][20] +- [Code Review Process][21] +- [Additional Contributor Information][22] + - [Coding Practices][25] + - [Merging Practices][23] + - [Project Examples][26] + - [Website Contributions][27] + - [Public API][24] + - [Contrib Projects][28] +- [Committer Documentation][32] +- [Project Governance][33] + + +## How to Contribute to Apache Accumulo + +Apache Accumulo welcomes contributions from the community. This is especially true of new contributors! You don?t need to be a software developer to contribute to Apache Accumulo. So, if you want to get involved in Apache Accumulo, there is almost certainly a role for you. View our [How to Contribute](/how-to-contribute/) page for additional details on the many opportunities available. + +## Project Resources + +Accumulo makes use of the following external tools for development. + +### GitHub + +Apache Accumulo source code is maintained using [Git] version control and mirrored to [GitHub][github]. Source files can be browsed [here][browse] or at the [GitHub mirror][mirror]. + +The project code can be checked-out [here][mirror]. It builds with [Apache Maven][maven]. + +### JIRA + +Accumulo [tracks issues][jiraloc] with [JIRA][jira]. Prospective code contributors can view [open issues labeled for "newbies"][newbies] to search for starter tickets. Note that every commit should reference a JIRA ticket of the form ACCUMULO-#. + +### Jenkins/TravisCI + +Accumulo uses [Jenkins][jenkins] and [TravisCI](https://travis-ci.org/apache/accumulo) for automatic builds and continuous integration. + +https://builds.apache.org/job/Accumulo-Master/lastBuild/buildStatus; style="height: 1.1em"> [Master][masterbuild] + +https://builds.apache.org/job/Accumulo-1.8/lastBuild/buildStatus; style="height: 1.1em"> [1.8 Branch][18build] + +https://builds.apache.org/job/Accumulo-1.7/lastBuild/buildStatus; style="height: 1.1em"> [1.7 Branch][17build] + +## Create a Ticket for New Bugs or Feature + +If you run into a bug or think there is something that would benefit the project, we encourage you to file an issue at the [Apache Accumulo JIRA][jiraloc] page. Regardless of whether you have the time to provide the fix or implementation yourself, this will be helpful to the project. + +## Building Accumulo from Source + +### Installing Apache Thrift + +If you activate the 'thrift' Maven profile, the build of some modules will attempt to run the Apache Thrift command line to regenerate +stubs. If you activate this profile and don't have Apache Thrift installed and in your path, you will see a warning and +your build will fail. For Accumulo 1.5.0 and greater, install Thrift 0.9 and make sure that the 'thrift' command is in your path. +Watch out for THRIFT-1367; you may need to configure Thrift with --without-ruby. Most developers do not +need to install or modify the Thrift definitions as a part of developing against Apache Accumulo. + +### Checking out from Git + +There are several methods for obtaining the Accumulo source code. If you prefer to use SSH rather than HTTPS you can refer to the [GitHub help pages][github-help] for help in creating a GitHub account and setting up [SSH keys][ssh]. + + - from your Github Fork + +It is also possible to [fork][forking] a repository in GitHub so that you can freely experiment with changes without affecting the original project. You can then submit a [pull request](https://help.github.com/articles/about-pull-requests/) from your
[GitHub] jmark99 commented on a change in pull request #37: Accumulo 4714 Create landing page for new developers
jmark99 commented on a change in pull request #37: Accumulo 4714 Create landing page for new developers URL: https://github.com/apache/accumulo-website/pull/37#discussion_r149807799 ## File path: _includes/nav.html ## @@ -24,6 +24,8 @@ Documentation + Quickstart (1.x) + Quickstart (2.x) Review comment: I'll remove the link as it the info already exists in the quick-install file. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] jmark99 commented on a change in pull request #37: Accumulo 4714 Create landing page for new developers
jmark99 commented on a change in pull request #37: Accumulo 4714 Create landing page for new developers URL: https://github.com/apache/accumulo-website/pull/37#discussion_r149807353 ## File path: pages/INSTALL.md ## @@ -0,0 +1,1182 @@ + + + + + + + + Review comment: Not sure. I do not recall creating it. I'll delete it. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
