Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 2.84 KB

CONTRIBUTING.md

File metadata and controls

39 lines (28 loc) · 2.84 KB
Raw

Contributors Guide

Quick Start | FAQ | Javadocs | Contributing | Slack

Discuss contributions to DC/OS SDK using GitHub issues and make contributions with GitHub pull requests.

Bugs / Feature Requests

Think you’ve found a bug? Want to see a new feature? Please open a case in our issue management tool, JIRA:

  • Login to the DC/OS SDK Public JIRA. You will need a Github or Google account to use this service.
  • Navigate to the DC/OS SDK project.
  • Click Create Issue - Please provide as much information as possible about the issue type and how to reproduce it.
  • Github Issues for this project have been disabled.
  • Bug reports in JIRA for the DC/OS SDK project are public.

If you would like to propose a new feature or a significant change, first open an issue (instructions above) to discuss it. Project shepherds will provide feedback on the proposed change in terms of feasibility, design, and implementation guidance. While all proposals are welcome, those that conflict with our roadmap or design principles may not be accepted.

Creating Pull Requests

Create pull requests against the master branch. Be sure to include unit tests and integration tests, as well as updates to the documentation, default scheduler, and reference framework if necessary.

See the (testing documentation)[TESTING.md] for instructions on running static code checks and system integration tests.

Simple pull requests (e.g., to fix documentation or comments) are welcome without an issue, but any substantial changes require an issue and discussion ahead of time.

Merge Approvals

Pull requests are reviewed and tested prior to merging. Often shepherds will ask contributors to make changes based on our style guidelines, design principles, or project goals. An initial response is typically provided in less than one week.

Communication

Most communication is done primarily over Slack. Join us via https://chat.dcos.io in the #data-services and #data-services-dev channels, for users and developers respectively.

To build a healthy, respectful community, we follow Github’s community guidelines.

Licensing

DC/OS SDK is licensed under the Apache License, Version 2.0. Any code you submit must be under that license.

For significant changes, we may ask you to sign a Contributor License Agreement.