-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated changelog, added standard md files
- Loading branch information
Showing
11 changed files
with
79 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Authors | ||
|
||
AirSim was originally created by [Shital Shah](https://github.com/sytelus) during late 2016. Shital authored physics engine, multirotor model, car model, environment models, sensor models, all Unreal Engine related code, APIs, SimpleFlight firmware, computer vision components, documentation etc. | ||
|
||
[Chris Lovett](https://github.com/lovettchris), another original author, contributed the MavLink communication library, PX4 related components, Settings system, build system, several important bug fixes and so on. | ||
|
||
List of all contributors since our first release in February 2017 can be [found here](https://github.com/Microsoft/AirSim/graphs/contributors). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,17 @@ | ||
# Contributing | ||
|
||
## How To | ||
|
||
- Please read our [short and sweet coding guidelines](coding_guidelines.md). | ||
- For big changes such as adding new feature or refactoring, [file an issue first](https://github.com/Microsoft/AirSim/issues). We should talk! | ||
- Use our [recommended development workflow](dev_workflow.md) to make changes and test it. | ||
- Use [usual steps](https://akrabat.com/the-beginners-guide-to-contributing-to-a-github-project/) to make contributions just like other GitHub projects. If you are not familiar with Git Branch-Rebase-Merge workflow, please [read this first](http://shitalshah.com/p/git-workflow-branch-rebase-squash-merge/). | ||
|
||
## Do and Don't | ||
- Rebase your branch frequently with master (once every 2-3 days is ideal). | ||
- Use same style and formatting as rest of code even if it's not your preferred one. | ||
- Change any documentation that goes with code changes. | ||
- Do not include OS specific header files. | ||
- Keep your pull request small, ideally under 10 files. | ||
# Contributing | ||
|
||
## Quick Start | ||
- Please read our [short and sweet coding guidelines](coding_guidelines.md). | ||
- For big changes such as adding new feature or refactoring, [file an issue first](https://github.com/Microsoft/AirSim/issues). | ||
- Use our [recommended development workflow](dev_workflow.md) to make changes and test it. | ||
- Use [usual steps](https://akrabat.com/the-beginners-guide-to-contributing-to-a-github-project/) to make contributions just like other GitHub projects. If you are not familiar with Git Branch-Rebase-Merge workflow, please [read this first](http://shitalshah.com/p/git-workflow-branch-rebase-squash-merge/). | ||
|
||
## Checklist | ||
- Use same style and formatting as rest of code even if it's not your preferred one. | ||
- Change any documentation that goes with code changes. | ||
- Do not include OS specific header files or new 3rd party dependencies. | ||
- Keep your pull request small, ideally under 10 files. | ||
- Make sure you don't include large binary files. | ||
- When adding new includes, make dependency is absolutely necessary. | ||
- Rebase your branch frequently with master (once every 2-3 days is ideal). | ||
- Make sure your code would compile on Windows, Linux and OSX. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,18 @@ | ||
If you are looking for a new feature or bug fix, fire up your IDE, try playing around with source code and contribute back! | ||
What's better than filing issue? Filing a pull request :). | ||
# Read This First | ||
|
||
## If you are reporting a bug | ||
* Make sure to write **all reproduction steps** | ||
* Include full error message in text form | ||
* Search issues for error message before filing issue | ||
* Attach screenshot if applicable | ||
* Include code to run if applicable | ||
|
||
## If you have question | ||
* Add clear and concise title | ||
* Add OS, AirSim version, Python version, Unreal version if applicable | ||
* Include context on what you are trying to achieve | ||
* Include details of what you already did to find answers | ||
|
||
**What's better than filing issue? Filing a pull request :).** | ||
|
||
------------------------------------ (Remove above before filing the issue) ------------------------------------ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Support | ||
|
||
We highly recommend to take a look at source code and contribute to the project. Due to large number of incoming feature request we may not be able to get to your request in your desired timeframe. So please [contribute](CONTRIBUTING.md) :). | ||
|
||
* [Join AirSim Facebook Group](https://www.facebook.com/groups/1225832467530667/) | ||
* [File GitHub Issue](https://github.com/Microsoft/AirSim/issues) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters