Skip to content

Latest commit

 

History

History
124 lines (87 loc) · 5.87 KB

CONTRIBUTING.md

File metadata and controls

124 lines (87 loc) · 5.87 KB
Raw

Contributing

Getting Started

  • Set up dependencies:
script/bootstrap
  • Run tests locally:
script/test
  • Please set up EditorConfig for your editor to automatically comply with the .editorconfig
  • You should run script/bootstrap every time you pull changes to ensure that you have the latest dependencies and updates

Developing

  • The ANTLR-executable version of the Swift grammar (based on The Swift Programming Language: Summary of the Grammar) is located at src/main/antlr/com/sleekbyte/tailor/antlr/Swift.g4
  • The lexer, parser, and listener generated via ANTLR from the grammar are located in src/gen/java/com/sleekbyte/tailor/antlr/
  • If modifications to the ANTLR grammar are necessary, regenerate the lexer/parser/listener:
./gradlew build
  • Ensure that all new code is tested via unit and/or functional tests (src/test/java/)
  • Verify that your changes pass all tests and comply with the project's style guidelines:
script/cibuild

Committing Changes

  • Always create a new branch and submit your changes as a pull request
  • Please follow Tim Pope's Git commit message guidelines in A Note About Git Commit Messages
  • Specifically, ensure that the first line of your commit message is brief (50 chars or less) and "Capitalized with no terminating period", then leave a blank line and provide more detailed explanatory text if necessary in paragraph or bulleted form with "-" or "*"
  • Attempt to keep the amount of modified code per commit to a reasonable size and refer to any relevant issues with their ID, using the verbs fix/close/resolve to automatically close issues once the commit has been merged into master (e.g. "Fix #4: Add .travis.yml to test against Python 3.4")

Opening an Issue

  • Create issues for features, enhancements, bugs, or questions and always attempt to specify a label and milestone if possible
  • If you have discussed responsibility for an issue with a contributor then set them as the assignee, otherwise leave it unassigned and the issue will be triaged to any contributor
  • Use a descriptive phrase for the issue name, capitalized with no terminating period, e.g. "Set up continuous integration via Travis"

Creating a Pull Request (PR)

Naming a Branch

  • Open an issue describing what your branch will address; multiple branches may be used to address the same issue but refrain from addressing multiple issues in a single branch
  • Create feature branches off of master with the naming convention: aa-1-feature-description, where aa are your initials, 1 is the associated issue number, and feature-description is a descriptive phrase that describes your feature
  • Ensure branch names always use lower case letters, with hyphens to separate words, never underscores

Submitting a PR

  • Once your feature is complete, push your branch to GitHub and open a PR
  • PRs should be based on your branch name with your initials removed and the name capitalized, i.e. aa-1-feature-description will become "#1: Feature description"
  • If your PR shadows an issue, match the label and milestone to that issue
  • Assign a primary reviewer when opening your PR, and have at least 2 people endorse your request
  • If you are waiting for a second reviewer, you may reassign the PR to another contributor
  • If you make changes to a PR after receiving an endorsement, you must request another review from the endorser

Developer Certificate of Origin

By submitting a PR, you agree to the Developer Certificate of Origin:

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
660 York Street, Suite 102,
San Francisco, CA 94110 USA

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

Closing a PR

  • Once you have received two 👍s and the Travis CI build has passed, a maintainer will merge your branch into master and you may delete it from the remote
  • When merging your branch, ensure that the related issue is also resolved

Triaging Issues

Issues will be triaged during scrum from the Backlog and moved into Ready/In Progress using Waffle