Skip to content

Latest commit

 

History

History
28 lines (21 loc) · 2.58 KB

CONTRIBUTING.md

File metadata and controls

28 lines (21 loc) · 2.58 KB
Raw

Contributing to SDL Projects

Third party contributions are essential for making SDL great. However, we do have a few guidelines we need contributors to follow.

Issues

If writing a bug report, please make sure it has enough info. Include all relevant information.

If requesting a feature, understand that we appreciate the input! However, it may not immediately fit our roadmap, and it may take a while for us to get to your request.

Gitflow

We use Gitflow as our branch management system. Please follow gitflow's guidelines while contributing to any SDL project.

Pull Requests

  • Please follow the repository's for all code and documentation.
  • All feature branches should be based on develop and have the format feature/branch_name.
  • Minor bug fixes, that is bug fixes that do not change, add, or remove any public API, should be based on master and have the format hotfix/branch_name.
  • All pull requests should implement a single feature or fix a single bug. Pull Requests that involve multiple changes (it is our discretion what precisely this means) will be rejected with a reason.
  • All commits should separated into logical units, i.e. unrelated changes should be in different commits within a pull request.
  • Work in progress pull requests should have "[WIP]" in front of the Pull Request title. When you believe the pull request is ready to merge, remove this tag and @mention the appropriate SDL team to schedule a review.
  • All new code must include unit tests. Bug fixes should have a test that fails previously and now passes. All new features should be covered. If your code does not have tests, or regresses old tests, it will be rejected.
  • A great example of a pull request can be found here.

Contributor's License Agreement (CLA)

In order to accept Pull Requests from contributors, you must first sign the Contributor's License Agreement. If you need to make a change to information that you entered, please contact us.

Repository Specific Guidelines

  • SDL Server Style Guide
  • Please document all code written using JS Docs for methods and use inline code comments where it makes sense, i.e. for non-obvious code chunks.