Skip to content

Latest commit

 

History

History
43 lines (24 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

43 lines (24 loc) · 1.51 KB

The ORCID Team is always EXCITED to get contributions. Checkout our pointers below:

  1. Understand the basics

    Not sure what a pull request is, or how to submit one? Take a look at GitHub's excellent Collaborating Documentation first.

  • Feature requests should be made in the Ideas forum

    Don't create issues for feature requests in the GitHub issue tracker. Instead, search the Ideas Forum to see if your idea has already been suggested. If it has, you can vote and comment to show your support. If not, you can add a new idea.

  • Discuss non-trivial contribution ideas with committers

    If you're considering anything more than correcting a typo or fixing a minor bug, please discuss it on the [ORCID Technical Community Google Group] (https://groups.google.com/forum/?fromgroups#!forum/orcid-technical-community) mailing list before submitting a pull request.

  • Submit JUnit test cases for all behavior changes

    Search the codebase to find related unit tests and add additional @Test methods within.

  • Run all tests prior to submission

    Make sure that all tests pass prior to submitting your pull request. See the DEVSETUP.md Testing

  • Squash commits

    Use git rebase --interactive, git add --patch and other tools to "squash" multiple commits into atomic changes.

  • Also Make it fun :-)