Skip to content
This repository has been archived by the owner on May 31, 2023. It is now read-only.

Latest commit

 

History

History
76 lines (46 loc) · 3.23 KB

CONTRIBUTING.md

File metadata and controls

76 lines (46 loc) · 3.23 KB
Raw

Contributing

👍 🎉 Thanks for taking the time to contribute! 🎉 👍

The following is a set of guidelines for contributing to John Deere and its packages.

For the short term, we are not accepting pull requests as we work on a process to accept contributions from the community.

We expect to begin taking contributions in the near future.

In the meantime, here are some ways you should prepare your contributions for when they can be accepted when we are ready.

  • All changes must be test-driven.
  • Run mvn clean verify and ensure no failures or warnings.
  • Follows the Semantic Versioning rules.
  • There should be discussion via an Issue before breaking changes are developed.
  • Expect that before a pull request is accepted, all owners of the contributed copyrighted work (including companies) will have signed a Contributor License Agreement.
  • All contributions must adhere to our Copyright Policy.

Code of Conduct

This project adheres to a code of conduct.

By participating, you are expected to uphold this code.

Issues

Please review existing issues before creating a new one.

If it has already been reported, add a comment to the existing issue instead of creating a new one.

If it has not already been reported, create a new issue using the issue template, using a clear and descriptive title.

Pull Requests

Please use the pull request template when creating a new pull request.

Etiquette / Rules of Engagement

We try to follow GitHub's "How to Write the Perfect Pull Request", for both approach and feedback, to increase responsiveness.

In short, we try and adhere to the following etiquette / rules of engagement.

  • Please keep your commits and PRs as small and logically grouped as possible!
  • Fire off a "heads up" issue or PR so owners can be prepared and start thinking and / or buying into the implementation.
  • PR issuers / creators can @ mention owners if they have heard no reply within the expected timeframe.

Visual Indicators

To help distinguish between "must fix" and "just so you know / have you thought about" comments.

  • "Must Fix"
    • Pull request will not be merged* without addressing
    • ❌ :x:
  • "Just So You Know..." or "Have You Thought About?"
    • Pull request can be merged without addressing, but a conversation is highly encouraged. Changes can still happen with these comments, but they are not required.
    • 💡 :bulb:

Automation Over Nitpicking

In general, if it passes the automated build and security checks, you're good to go!

However, things like design, refactoring, semantic HTML, etc. probably can't be automated easily, so those are still valid code review comments to leave.

Timeliness

To account for the maintainer potentially being on vacation, please give two weeks for a review.

Verification

All pull request must be able to have a passing build, if enabled, before they will be accepted.

Please see the project README for instructions on how to test locally.

Privacy

See the Privacy Statement.