Skip to content

Latest commit

 

History

History
33 lines (27 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

33 lines (27 loc) · 1.27 KB
Raw

Contributing to jKif Parser

General Workflow

  1. Fork the repo
  2. Cut namespaced feature branch with initials from master
  • FL_bug/...
  • FL_feat/...
  • FL_test/...
  • FL_doc/...
  • FL_refactor/...
  1. Make commits to your feature branch (only make changes that are relevant to this branch)
  • commit messages should start with a capital letter
  • commit messages should be in the present tense
  • commit messages should not end with a '.'
  1. When you've finished with your fix or feature:
  • git fetch upstream master
  • git rebase upstream/master
  • submit a pull request directly to master. Include a description of your changes.
  1. Your pull request will be reviewed by another maintainer. The point of code reviews is to help keep the codebase clean and of high quality.
  2. Fix any issues raised by your code reviewer, and push your fixes as a single new commit.
  3. Once the pull request has been reviewed, it will be merged by another member of the team. Do not merge your own pull requests.

Guidelines

  1. Uphold the current code standard:
  2. Run the tests before submitting a pull request.
  3. Submit tests if your pull request contains new, testable behavior.

Thanks for contributing!