Repository: lucy Updated Branches: refs/heads/accept_github_prs [created] b678f5071
Update policy to accept Github pull requests. Project: http://git-wip-us.apache.org/repos/asf/lucy/repo Commit: http://git-wip-us.apache.org/repos/asf/lucy/commit/b678f507 Tree: http://git-wip-us.apache.org/repos/asf/lucy/tree/b678f507 Diff: http://git-wip-us.apache.org/repos/asf/lucy/diff/b678f507 Branch: refs/heads/accept_github_prs Commit: b678f50718f1796f2c4d08ae4c3478067b8b21b8 Parents: 58ee0f6 Author: Marvin Humphrey <[email protected]> Authored: Fri Aug 1 17:36:24 2014 -0700 Committer: Marvin Humphrey <[email protected]> Committed: Fri Aug 1 18:32:39 2014 -0700 ---------------------------------------------------------------------- CONTRIBUTING | 36 ++++++++++++++++++++---------------- 1 file changed, 20 insertions(+), 16 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/lucy/blob/b678f507/CONTRIBUTING ---------------------------------------------------------------------- diff --git a/CONTRIBUTING b/CONTRIBUTING index cb2eb95..967353a 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -25,10 +25,11 @@ GET THE CODE: https://github.com/apache/lucy + Follow the instructions in INSTALL to set up your local workspace. + MAKE CHANGES: - Edit the source code as you see fit, then follow the instructions in INSTALL - to build Lucy and run its test suite. + Edit the source code as you see fit, then build Lucy and run its test suite. Please bear the following in mind: @@ -44,17 +45,7 @@ MAKE CHANGES: within the Lucy development community; the simpler the contribution, the more quickly it can be reviewed and integrated. -GENERATE A PATCH: - - The easiest way to create a patch with Git is to capture the output of - `git diff`: - - git diff > my_changes.patch - - More experienced Git users may wish to generate patch sequences using - `git format-patch`. - -CONTRIBUTE YOUR PATCH +OPEN AN ISSUE: Lucy's issue-tracker/bug-tracker installation runs Atlassian JIRA and we generally use the term "issue" rather than "bug" because not every @@ -65,7 +56,7 @@ CONTRIBUTE YOUR PATCH 1. Create a JIRA account for yourself and sign in. 2. Once you have signed in, the "create new issue" link will appear. Either use it to open a new issue or navigate to an existing one as appropriate. - 3. Attach your patch to the issue using the menu command + 3. To attach files to an issue, use the menu command 'More Actions > Attach Files'. Attaching a file to an issue causes an email notification to be sent to the @@ -73,8 +64,21 @@ CONTRIBUTE YOUR PATCH persistent while engaging with the Lucy committers who review and apply such patches. +CONTRIBUTE A PATCH: + + The easiest way to create a patch with Git is to capture the output of + `git diff`: + + git diff > my_changes.patch + + The resulting patch file can then be attached to a JIRA issue. + GITHUB PULL REQUESTS - At this time, we have no way to accept pull requests for the Github - read-only mirror, so please use the JIRA patch submission process. + Github users may submit pull requests against our mirror: + + https://github.com/apache/lucy + + An email notifying the Lucy developers list of your pull request will be + triggered automatically.
