Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

There are many ways to contribute to Rya. We'll try to document them here. All contributions, code or not code, are important. 

Contributions:

Here are some types of contributions. Any positive contribution to the project is welcome:

  • Use our project and provide feedback.
  • Ask and answer questions on the dev@rya.incubator.apache.org users list
  • Contribute javadocs, documentation.
  • Provide us with use-cases.
  • Report bugs and submit patches.
  • Contribute code.
  • Contribute to the Rya website
  • Help spread the word about the project
  • Review pull requests
  • Verify releases
  • Anything else that contributes to health of the Rya project and community

To report a bug/propose work:

-create a JIRA ticket for the issue, using the Apache JIRA system: https://issues.apache.org/jira/browse/RYA (new users need to create a user account)

To

Find Bugs

find bugs/

Issues

issues to work on:

-Browse issues in JIRA and find one that you'd like to work on.

-Create a JIRA account for yourself and email dev@rya.incubator.apache.org your username and ask to be added to the contributors list for JIRA

-If you're new to Rya, and you'd like to get your feet wet with a simple issue, search for issues labeled "beginner"

-Assign the issue to yourself, and mark the issue as "In Progress"

-Feel free to email dev@rya.incubator.apache.org for help or advice

To contribute code:

-find/file the JIRA ticket for that topic
-fork the code from the Github Apache repository https://github.com/apache/incubator-rya
-clone the fork, create a new branch, push commits to the branch
-create a pull request and add it to the JIRA ticket

-a committer will look at it and integrate it in the code /or not

How to become a committer:

To find out how to become a committer for Rya, please read the ASF gudides listed below. Bottom line is, if you contribute to the project and show commitment to the project and ASF values of open communication, inclusion, diversity, meritocracy, the current committers will notice and it is likely they will invite you to become a committer.

http://www.apache.org/dev/new-committers-guide.html

http://www.apache.org/foundation/getinvolved.html#become-a-committer 

Commit Process for Committers:

...

Step 5: Update JIRA Ticket

 


The Example below demonstrates merging in a pull request from GitHub into the Apache Rya-Incubator repository. This specific Pull Request used for this example is here

...

Set the click on the "Close Issue" button in JIRA.

...


Closing Stale Issues on Github

 


Github issues are closed via commit messages to the master branch.  Typically we pull in a PR and close the PR by amending the commit message with the "closes #xxx" line.

But sometimes we need to close a PR without pulling in the PR.  Instead, create an "Empty Commit" and document the reason for the commit in the commit message. 


Code Block
titleCreating an Empty Commit
git commit --allow-empty

...

Code Block
titleMessage for an Empty Commit to Close a PR
EMPTY COMMIT Closes #110, Closes #109

An Empty Commit to close issues in GitHub

 

...