Skip to content

Latest commit

 

History

History
49 lines (40 loc) · 2.58 KB

CONTRIBUTING.md

File metadata and controls

49 lines (40 loc) · 2.58 KB
Raw

Contributing to Feign

Please read HACKING prior to raising change.

If you would like to contribute code you can do so through GitHub by forking the repository and sending a pull request (on a branch other than master or gh-pages).

Pull Requests

Pull requests eventually need to resolve to a single commit. The commit log should be easy to read as a change log. We use the following form to accomplish that.

  • First line is a <=72 character description in present tense, explaining what this does.
    • Ex. "Fixes regression on encoding vnd headers" > "Fixed encoding bug", which forces the reader to look at code to understand impact.
  • Do not include issue links in the first line as that makes pull requests look weird.
    • Ex. "Addresses #345" becomes a pull request title: "Addresses #345 #346"
  • After the first line, use markdown to concisely summarize the implementation.
    • This isn't in leiu of comments, and it assumes the reader isn't intimately familar with code structure.
  • If the change closes an issue, note that at the end of the commit description ex. "Fixes #345"
    • GitHub will automatically close change with this syntax.
  • If the change is notable, also update the change log with your summary description.
    • The unreleased minor version is often a good default.

Code Style

When submitting code, please use the feign code format conventions. If you use Eclipse m2eclipse should take care of all settings automatically. You can also import formatter settings using the eclipse-java-style.xml file. If using IntelliJ IDEA, you can use the Eclipse Code Formatter Plugin to import the same file.

License

By contributing your code, you agree to license your contribution under the terms of the APLv2

All files are released with the Apache 2.0 license.

If you are adding a new file it should have a header like this:

/**
 * Copyright 2012 The Feign Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */