Repository: lucy-clownfish Updated Branches: refs/heads/prep_0.4.0 [created] 168e87dc1
Mod CONTRIBUTING to accept Github pull requests. Project: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/repo Commit: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/commit/cac11a49 Tree: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/tree/cac11a49 Diff: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/diff/cac11a49 Branch: refs/heads/prep_0.4.0 Commit: cac11a4963d66ca3175642c869c88027a3a9139b Parents: d73098d Author: Marvin Humphrey <[email protected]> Authored: Tue Aug 12 15:51:43 2014 -0700 Committer: Marvin Humphrey <[email protected]> Committed: Tue Aug 12 15:51:43 2014 -0700 ---------------------------------------------------------------------- CONTRIBUTING | 52 ++++++++++++++++++++++++++++++---------------------- 1 file changed, 30 insertions(+), 22 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/cac11a49/CONTRIBUTING ---------------------------------------------------------------------- diff --git a/CONTRIBUTING b/CONTRIBUTING index af1048f..4594ccd 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -1,9 +1,13 @@ -========================= -Contributing to Clownfish -========================= +================================ +Contributing to Apache Clownfish +================================ MAKE A PLAN: + Clownfish is developed by the Apache Lucy community. + + http://lucy.apache.org/ + If you propose to make non-trivial changes to Clownfish, especially changes to the public API, send a note to the Lucy developer's list describing your plans: @@ -21,10 +25,11 @@ GET THE CODE: https://github.com/apache/lucy-clownfish + 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 Clownfish and run its test suite. + Edit the source code as you see fit, then build and run tests. Please bear the following in mind: @@ -40,28 +45,18 @@ 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 - contribution fixes a "bug". + Clownfish uses Lucy's issue-tracker/bug-tracker installation, which runs + Atlassian JIRA. We generally use the term "issue" rather than "bug" because + not every contribution fixes a "bug". https://issues.apache.org/jira/browse/LUCY 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 @@ -69,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-clownfish + + An email notifying the Lucy developers list of your pull request will be + triggered automatically.
