You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Third party contributions are essential for making SDL great. However, we do have a few guidelines we need contributors to follow.
4
+
5
+
### Issues
6
+
7
+
If writing a bug report, please make sure <ahref="http://yourbugreportneedsmore.info"target="_blank">it has enough info</a>. Include all relevant information.
8
+
9
+
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.
10
+
11
+
### Gitflow
12
+
13
+
We use <ahref="http://nvie.com/posts/a-successful-git-branching-model/">Gitflow</a> as our branch management system. Please follow gitflow's guidelines while contributing to any SDL project.
14
+
15
+
### Pull Requests
16
+
17
+
* Please follow the repository's for all code and documentation.
18
+
* All feature branches should be based on `develop` and have the format `feature/branch_name`.
19
+
* 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`.
20
+
* 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.
21
+
* All commits should separated into logical units, i.e. unrelated changes should be in different commits within a pull request.
22
+
* 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.
23
+
* 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.
24
+
* A great example of a <a href="https://github.com/smartdevicelink/SmartDeviceLink-iOS/pull/45" "_target>pull request can be found here</a>.
25
+
26
+
### Contributor's License Agreement (CLA)
27
+
28
+
In order to accept Pull Requests from contributors, you must first sign [the Contributor's License Agreement](https://docs.google.com/forms/d/1VNR8EUd5b46cQ7uNbCq1fJmnu0askNpUp5dudLKRGpU/viewform). If you need to make a change to information that you entered, [please contact us](mailto:theresa@livio.io).
29
+
30
+
### Repository Specific Guidelines
31
+
32
+
* Please follow all the guidelines defined in the [Architecture & Contribution Guidelines](../GUIDELINES.md)
[Delete any non-applicable sections, but we may ask for more information. Please reference the [SmartDeviceLink GitHub Best Practices](https://d83tozu1c8tt6.cloudfront.net/media/resources/SDL_GitHub_BestPractices.pdf) for further instructions on how to enter an issue.]
2
+
3
+
### Bug Report
4
+
[Summary]
5
+
6
+
##### Reproduction Steps
7
+
1.[Step 1]
8
+
2.[Step 2]
9
+
3.[Step 3]
10
+
11
+
##### Expected Behavior
12
+
[Some expected behavior]
13
+
14
+
##### Observed Behavior
15
+
[Some observed behavior]
16
+
17
+
##### Browser & Version Information
18
+
* Browser and Version:[What browser is being used including its version are you using when the bug occurred]
19
+
* SDL JavaScript Suite Module: [What module (node, javascript, etc) were you using that is experiencing the bug?
20
+
* SDL JavaScript Version: [What version of the library has this bug been seen on]
21
+
* Testing Against: [What you tested with to observe this behavior]
22
+
23
+
##### Test Case, Sample Code, and / or Example App
24
+
[Paste a link to a PR, gist, or other code that exemplifies this behavior]
[Things to note: Pull Requests **must** fix an issue. Discussion about the feature / bug takes place in the issue, discussion of the implementation takes place in the PR. Please also see the [Contributing Guide](./CONTRIBUTING.md) for information on branch naming and the CLA, and the [SmartDeviceLink GitHub Best Practices](https://d83tozu1c8tt6.cloudfront.net/media/resources/SDL_GitHub_BestPractices.pdf) document for more information on how to enter a pull request. Once this PR is ready for review, please request one from @nickschwab.
2
+
3
+
Delete the above section when you've read it.]
4
+
5
+
Fixes #[issue number]
6
+
7
+
This PR is **[ready / not ready]** for review.
8
+
9
+
### Risk
10
+
This PR makes **[no / minor / major]** API changes.
11
+
12
+
### Testing Plan
13
+
[Describe how you plan to unit test the changes in this PR]
14
+
15
+
### Summary
16
+
[Summary of PR changes]
17
+
18
+
### Changelog
19
+
##### Breaking Changes
20
+
*[Breaking change info]
21
+
22
+
##### Enhancements
23
+
*[Enhancement info]
24
+
25
+
##### Bug Fixes
26
+
*[Bug Fix Info]
27
+
28
+
### Tasks Remaining:
29
+
-[ ][Task 1]
30
+
-[ ][Task 2]
31
+
32
+
### CLA
33
+
-[ ] I have signed [the CLA](https://docs.google.com/forms/d/e/1FAIpQLSdsgJY33VByaX482zHzi-xUm49JNnmuJOyAM6uegPQ2LXYVfA/viewform) and this pull request adheres to the [Contributing Guide](./CONTRIBUTING.md).
0 commit comments