Skip to content

Commit 4e40502

Browse files
Documentation/contribution code of conduct update (#13)
Add CONTRIBUTING.md to the root of the repository instead of as a wiki for better Github integration. Added CODE_OF_CONDUCT.md.
1 parent 0d6a4a0 commit 4e40502

File tree

3 files changed

+71
-8
lines changed

3 files changed

+71
-8
lines changed

CODE_OF_CONDUCT.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
We want a productive, happy community that can welcome new ideas and foster collaboration. This code of conduct exists to ensure that diverse groups collaborate to mutual advantage and enjoyment. We will challenge prejudice that could jeopardize the participation of any person in this project.
2+
3+
## Our Standards and Responsibilities
4+
* Be considerate and respectful of differing viewpoints and experiences.
5+
* Be collaborative and ask for help when unsure.
6+
* Gracefully accept constructive criticism.
7+
* Resolve disagreements constructively and value discussion, clarity and consensus.
8+
* Take responsibility when a mistake is made and work to right the wrong.
9+
10+
A community where people feel uncomfortable or threatened is not a productive one. We would like to build an environment where the community works together to resolve conflicts. In order to do this, the project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
11+
12+
## Scope
13+
This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces.
14+
15+
This Code is not exhaustive or complete. It is not a rulebook; it serves to distill our common understanding of a collaborative, shared environment and goals. We expect it to be followed in spirit as much as in the letter.
16+
17+
## Attribution
18+
This Code of Conduct has been adapted from the [Ubuntu Code of Conduct v2.0](https://www.ubuntu.com/community/code-of-conduct) and the [Contributor Covenant v1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html).

CONTRIBUTING.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
Our aim is to continue to update the DJI UX SDK, making it easier and better to use. Further development of DJI UX SDK will now be done in this open sourced repository on GitHub, and we look forward to contributions from the community. We hope this document makes the process for contributing clear and answers some questions that you might have.
2+
3+
## Code of Conduct
4+
We are committed to providing an inspiring and welcoming community for everyone. In order to do this, we expect everyone who participates to honor our [code of conduct](https://github.com/dji-sdk/Mobile-UXSDK-Beta-iOS/blob/master/CODE_OF_CONDUCT.md).
5+
6+
## Development
7+
The iOS UX SDK team develops new features in an internal repository, which are released alongside with new MSDK releases. The iOS UX SDK team is actively working on improving this process to bring over bug fixes and improvements to this open source repository as they are needed.
8+
9+
External contributors can send pull requests for bugs and improvements, following the guidelines described in [Branch Organization](#branch-organization). For bigger changes like adding a feature or changing a public API, we recommend filing a [Github issue](https://github.com/dji-sdk/Mobile-UXSDK-Beta-iOS/issues) which lets us reach an agreement on your proposal before you put significant effort into it.
10+
11+
The core team members may add additional features at their discretion after an internal review.
12+
13+
_**Note:** The core team is already working on the legacy widgets and panels that are present in the latest version of UXSDK 4.x._
14+
15+
16+
## Code Style Guide
17+
All contributors must follow the [Objective-C style guide](https://github.com/dji-sdk/Open-Source-UXSDK-iOS/wiki/Objective-C-Style-Guide) and the [Swift sytle guide](https://github.com/dji-sdk/Mobile-UXSDK-Beta-iOS/wiki/Swift-Style-Guide).
18+
19+
## Branch Organization
20+
We will keep the master branch up to date, with tests passing at all times. When making any changes, we recommend that you start with the latest version of the master branch.
21+
22+
If you send a pull request, please do it against the master branch. We maintain stable branches for major versions separately but we don’t accept pull requests to them directly. Instead, we cherry-pick non-breaking changes from master to the latest stable major version.
23+
24+
## Bugs
25+
We are using [Github issues](https://github.com/dji-sdk/Mobile-UXSDK-Beta-iOS/issues) for our public bugs. We keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new bug, try to make sure your problem doesn’t already exist. The best way to get your bug fixed is to provide a reduced test case to accurately reproduce the bug along with information about the DJI platform used and its firmware version, the iOS device used and its OS version as well as specifics of the test (in-flight, during simulation of the aircraft etc).
26+
27+
## Pull Requests
28+
If you haven't worked on pull requests before you can learn how from this free video series:
29+
30+
[How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)
31+
32+
If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don’t accidentally duplicate your effort. If somebody claims an issue but doesn’t follow up for more than two weeks, it’s fine to take it over, but you should still leave a comment.
33+
34+
The core team is monitoring for pull requests. We will review your pull request and either merge it, request changes to it, or close it with an explanation. For API changes we may need to fix our internal lower level code, which could cause some delay. We’ll do our best to provide updates and feedback throughout the process.
35+
36+
**Before submitting a pull request, please make sure the following is done:**
37+
1. Fork the repository and create your branch from master.
38+
1. Format your code and make sure it follows the style guide.
39+
1. Add tests if you’ve fixed a bug or added code that should be tested.
40+
1. Ensure the test suite passes.
41+
42+
## Support
43+
For any bugs or feature requests please use [Github issues](https://github.com/dji-sdk/Mobile-UXSDK-Beta-iOS/issues) as mentioned above.
44+
45+
You can send an email to dev@dji.com for any development support questions. You can also post questions, keep up to date on DJI developer news and contribute to the community by visiting the [DJI's Developer Forum here](https://forum.dji.com/forum-139-1.html?from=developer)

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The DJI UX SDK speeds up development time by providing UI elements for all core
44

55
With the UX SDK 5.0 version we are introducing an easy way to customize all the UI elements, as well as extend the base classes to build your own custom widgets. For more details, see the [UX SDK 5.0 overview](https://github.com/dji-sdk/Open-Source-UXSDK-iOS/wiki).
66

7-
Check out our [sample app](https://github.com/dji-sdk/Mobile-UXSDK-Beta-iOS/tree/master/UXSDKBetaSampleApp) to get started.
7+
Check out our sample app code in this repository with instructions on how to get started [here](https://github.com/dji-sdk/Open-Source-UXSDK-iOS/UXSDKBetaSample).
88

99
## Installation
1010

@@ -14,21 +14,21 @@ Read the [documentation for installation](https://github.com/dji-sdk/Open-Source
1414

1515
You can find the UX SDK documentation on the [wiki](https://github.com/dji-sdk/Open-Source-UXSDK-iOS/wiki). This includes -
1616
* UX SDK 5.0 overview and main concepts
17-
* Documentation for all the individual widgets
18-
* Contribution guidelines
19-
* Where to get support
17+
* Documentation for all the individual widgets and panels
18+
* Sample app tutorial
2019

2120
## How to Contribute
2221

23-
As always, the DJI Dev Team is committed to improving your developer experience. Please follow our guidelines on the [How to Contribute](https://github.com/dji-sdk/Open-Source-UXSDK-iOS/wiki/How-to-Contribute) page on our wiki for filling out any bugs or feature requests, or contribute to the code base. If you have any other questions, please send an email to dev@dji.com. We recommend frequently checking the Github repositories for changes and new releases.
22+
As always, the DJI Dev Team is committed to improving your developer experience. Please follow our guidelines on the [CONTRIBUTING.md](https://github.com/dji-sdk/Mobile-UXSDK-Beta-iOS/blob/master/CONTRIBUTING.md) file for filling out any bugs or feature requests, contributing to the code base, or how to get support.
23+
If you have any other questions, please send an email to dev@dji.com. We recommend frequently checking the Github repositories for changes and new releases.
2424
You can also post questions, keep up to date on DJI developer news and contribute to the community by visiting the [DJI's Developer Forum here](https://forum.dji.com/forum-139-1.html?from=developer)
2525

2626
## Future Plans
2727

28-
This Beta 3 release only contains a subset of UX SDK elements. We are eager to give you a sneak peek, and are very interested in receiving your feedback and suggestions. Please refer to the release notes for the full list of elements that Beta 3 version makes available.
28+
We are eager to give you a sneak peek, and are very interested in receiving your feedback and suggestions. Please refer to the wiki or the release notes for the full list of elements that the Beta 3 version makes available.
2929

30-
Our long-term plan is for this framework to reach feature parity with the UX SDK 4.13 release. The core team is currently working on porting the remaining widgets and other APIs to the new architecture and we will open source them in future Beta releases as they are completed. We welcome your feedback on the architecture and your ideas for addional widgets, including those not included in prior UX SDK releases, as well as your contributions and PRs for any ***currently open-sourced features***.
30+
Our long-term plan is for this framework to reach feature parity with the UX SDK 4.x release. The core team is currently working on porting the remaining widgets and other APIs to the new architecture and we will open source them in additional future Beta releases as they are completed. We welcome your feedback on the architecture and your ideas for additional widgets, including those not included in prior UX SDK releases, as well as your contributions and PRs for any ***currently open-sourced features***.
3131

3232
## License
3333

34-
DJI UX SDK Beta is released under the MIT license. See [LICENSE](https://github.com/dji-sdk/Open-Source-UXSDK-iOS/blob/master/LICENSE) for details.
34+
Mobile-UXSDK-Beta-iOS is released under the MIT license. See [LICENSE.txt](https://github.com/dji-sdk/Open-Source-UXSDK-iOS/blob/master/LICENSE) file for more info.

0 commit comments

Comments
 (0)