CONTRIBUTING.md in solrizer-3.4.1 vs CONTRIBUTING.md in solrizer-4.0.0

- old
+ new

@@ -1,10 +1,17 @@ # How to Contribute We want your help to make Project Hydra great. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. +## Code of Conduct + +The Hydra community is dedicated to providing a welcoming and positive experience for all its +members, whether they are at a formal gathering, in a social setting, or taking part in activities +online. Please see our [Code of Conduct](https://wiki.duraspace.org/display/hydra/Code+of+Conduct) +for more information. + ## Hydra Project Intellectual Property Licensing and Ownership All code contributors must have an Individual Contributor License Agreement (iCLA) on file with the Hydra Project Steering Group. If the contributor works for an institution, the institution must have a Corporate Contributor License Agreement (cCLA) on file. @@ -14,12 +21,14 @@ ## Contribution Tasks * Reporting Issues * Making Changes +* Documenting Code +* Committing Changes * Submitting Changes -* Merging Changes +* Reviewing and Merging Changes ### Reporting Issues * Make sure you have a [GitHub account](https://github.com/signup/free) * Submit a [Github issue](./issues) by: @@ -36,12 +45,32 @@ * This is usually the master branch. * To quickly create a topic branch based on master; `git branch fix/master/my_contribution master` * Then checkout the new branch with `git checkout fix/master/my_contribution`. * Please avoid working directly on the `master` branch. * You may find the [hub suite of commands](https://github.com/defunkt/hub) helpful +* Make sure you have added sufficient tests and documentation for your changes. + * Test functionality with RSpec; est features / UI with Capybara. +* Run _all_ the tests to assure nothing else was accidentally broken. + +### Documenting Code + +* All new public methods, modules, and classes should include inline documentation in [YARD](http://yardoc.org/). + * Documentation should seek to answer the question "why does this code exist?" +* Document private / protected methods as desired. +* If you are working in a file with no prior documentation, do try to document as you gain understanding of the code. + * If you don't know exactly what a bit of code does, it is extra likely that it needs to be documented. Take a stab at it and ask for feedback in your pull request. You can use the 'blame' button on GitHub to identify the original developer of the code and @mention them in your comment. + * This work greatly increases the usability of the code base and supports the on-ramping of new committers. + * We will all be understanding of one another's time constraints in this area. +* YARD examples: + * [Hydra::Works::RemoveGenericFile](https://github.com/projecthydra-labs/hydra-works/blob/master/lib/hydra/works/services/generic_work/remove_generic_file.rb) + * [ActiveTriples::LocalName::Minter](https://github.com/ActiveTriples/active_triples-local_name/blob/master/lib/active_triples/local_name/minter.rb) +* [Getting started with YARD](http://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md) + +### Committing changes + * Make commits of logical units. - * Your commit should include a high level description of your work in HISTORY.textile + * Your commit should include a high level description of your work in HISTORY.textile * Check for unnecessary whitespace with `git diff --check` before committing. * Make sure your commit messages are [well formed](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). * If you created an issue, you can close it by including "Closes #issue" in your commit message. See [Github's blog post for more details](https://github.com/blog/1386-closing-issues-via-commit-messages) ``` @@ -58,11 +87,13 @@ Description can have multiple paragraphs and you can use code examples inside, just indent it with 4 spaces: class PostsController def index - respond_with Post.limit(10) + respond_to do |wants| + wants.html { render 'index' } + end end end You can also add bullet points: @@ -70,41 +101,56 @@ - also, try to indent next line of a point for readability, if it's too long to fit in 72 characters ``` -* Make sure you have added the necessary tests for your changes. -* Run _all_ the tests to assure nothing else was accidentally broken. -* When you are ready to submit a pull request - ### Submitting Changes -[Detailed Walkthrough of One Pull Request per Commit](http://ndlib.github.io/practices/one-commit-per-pull-request/) - * Read the article ["Using Pull Requests"](https://help.github.com/articles/using-pull-requests) on GitHub. * Make sure your branch is up to date with its parent branch (i.e. master) * `git checkout master` * `git pull --rebase` * `git checkout <your-branch>` * `git rebase master` - * It is likely a good idea to run your tests again. -* Squash the commits for your branch into one commit - * `git rebase --interactive HEAD~<number-of-commits>` ([See Github help](https://help.github.com/articles/interactive-rebase)) - * To determine the number of commits on your branch: `git log master..<your-branch> --oneline | wc -l` + * It is a good idea to run your tests again. +* If you've made more than one commit take a moment to consider whether squashing commits together would help improve their logical grouping. + * [Detailed Walkthrough of One Pull Request per Commit](http://ndlib.github.io/practices/one-commit-per-pull-request/) + * `git rebase --interactive master` ([See Github help](https://help.github.com/articles/interactive-rebase)) * Squashing your branch's changes into one commit is "good form" and helps the person merging your request to see everything that is going on. * Push your changes to a topic branch in your fork of the repository. * Submit a pull request from your fork to the project. -### Merging Changes +### Reviewing and Merging Changes -* It is considered "poor from" to merge your own request. -* Please take the time to review the changes and get a sense of what is being changed. Things to consider: +We adopted [Github's Pull Request Review](https://help.github.com/articles/about-pull-request-reviews/) for our repositories. +Common checks that may occur in our repositories: + +1. Travis CI - where our automated tests are running +2. Hound CI - where we check for style violations +3. Approval Required - Github enforces at least one person approve a pull request. Also, all reviewers that have chimed in must approve. +4. CodeClimate - is our code remaining healthy (at least according to static code analysis) + +If one or more of the required checks failed (or are incomplete), the code should not be merged (and the UI will not allow it). If all of the checks have passed, then anyone on the project (including the pull request submitter) may merge the code. + +*Example: Carolyn submits a pull request, Justin reviews the pull request and approves. However, Justin is still waiting on other checks (Travis CI is usually the culprit), so he does not merge the pull request. Eventually, all of the checks pass. At this point, Carolyn or anyone else may merge the pull request.* + +#### Things to Consider When Reviewing + +First, the person contributing the code is putting themselves out there. Be mindful of what you say in a review. + +* Ask clarifying questions +* State your understanding and expectations +* Provide example code or alternate solutions, and explain why + +This is your chance for a mentoring moment of another developer. Take time to give an honest and thorough review of what has changed. Things to consider: + * Does the commit message explain what is going on? - * Does the code changes have tests? _Not all changes need new tests, some changes are refactorings_ + * Does the code changes have tests? _Not all changes need new tests, some changes are refactors_ + * Do new or changed methods, modules, and classes have documentation? * Does the commit contain more than it should? Are two separate concerns being addressed in one commit? - * Did the Travis tests complete successfully? -* If you are uncertain, bring other contributors into the conversation by creating a comment that includes their @username. -* If you like the pull request, but want others to chime in, create a +1 comment and tag a user. + * Does the description of the new/changed specs match your understanding of what the spec is doing? + +If you are uncertain, bring other contributors into the conversation by assigning them as a reviewer. # Additional Resources * [General GitHub documentation](http://help.github.com/) * [GitHub pull request documentation](http://help.github.com/send-pull-requests/)