Skip to content

Latest commit

 

History

History
81 lines (53 loc) · 3.41 KB

CONTRIBUTING.md

File metadata and controls

81 lines (53 loc) · 3.41 KB
Raw

Legal

By submitting a pull request, you represent that you have the right to license your contribution to Apple and the community, and agree by submitting the patch that your contributions are licensed under the Apache 2.0 license (see LICENSE.txt).

How to submit a bug report

Please ensure to specify the following:

  • Swift Cluster Membership commit hash
  • Contextual information (e.g. what you were trying to achieve with Swift Cluster Membership)
  • Simplest possible steps to reproduce
    • More complex the steps are, lower the priority will be.
    • A pull request with failing test case is preferred, but it's just fine to paste the test case into the issue description.
  • Anything that might be relevant in your opinion, such as:
    • Swift version or the output of swift --version
    • OS version and the output of uname -a
    • Network configuration

Example

Swift Cluster Membership commit hash: 22ec043dc9d24bb011b47ece4f9ee97ee5be2757

Context:
While load testing my HTTP web server written with Swift Cluster Membership, I noticed
that one file descriptor is leaked per request.

Steps to reproduce:
1. ...
2. ...
3. ...
4. ...

$ swift --version
Swift version 4.0.2 (swift-4.0.2-RELEASE)
Target: x86_64-unknown-linux-gnu

Operating system: Ubuntu Linux 16.04 64-bit

$ uname -a
Linux beefy.machine 4.4.0-101-generic #124-Ubuntu SMP Fri Nov 10 18:29:59 UTC 2017 x86_64 x86_64 x86_64 GNU/Linux

My system has IPv6 disabled.

Writing a Patch

A good Swift Cluster Membership patch is:

  1. Concise, and contains as few changes as needed to achieve the end result.
  2. Tested, ensuring that any tests provided failed before the patch and pass after it.
  3. Documented, adding API documentation as needed to cover new functions and properties.
  4. Adheres to our code formatting conventions and style guide.
  5. Accompanied by a great commit message, using our commit message template.

You should run the scripts/sanity.sh script before submitting your pull request. It will check formatting and other rules and fail if they are not in accordance to the project's rules, e.g. fixing all the formatting along the way.

Once the sanity script passes, you are ready to submit your pull request!

Code Format and Style

Swift Cluster Membership uses SwiftFormat to enforce the preferred swift code format. Always run SwiftFormat before committing your code.

Commit Message Template

We require that your commit messages match our template. The easiest way to do that is to get git to help you by explicitly using the template. To do that, cd to the root of our repository and run:

git config commit.template dev/git.commit.template

Test on Linux

Swift Cluster Membership uses XCTest to run tests on both macOS and Linux. While the macOS version of XCTest is able to use the Objective-C runtime to discover tests at execution time, the Linux version is not. For this reason, whenever you add new tests you will want to run a script that generates the hooks needed to run those tests on Linux, or our CI will complain that the tests are not all present on Linux. To do this, merely execute ./scripts/generate_linux_tests.rb at the root of the package and check the changes it made.

How to contribute your work

Please open a pull request at https://github.com/apple/swift-cluster-membership. Make sure the CI passes, and then wait for code review.