Skip to content

Commit

Permalink
updated who_is_using, Trello link, contrib guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
sytelus committed Nov 18, 2017
1 parent d2dd118 commit 1a4a51b
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 19 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ More technical details are available in [AirSim paper (FSR 2017 Conference)](htt

### Contribute

We welcome contributions to help advance research frontiers.
We welcome contributions to help advance research frontiers. Please take a look at [open issues](https://github.com/microsoft/airsim/issues) and [Trello board](https://trello.com/b/1t2qCeaA/todo) if you are looking for areas to contribute to.

* [More on AirSim design](docs/design.md)
* [More on code structure](docs/code_structure.md)
Expand Down
23 changes: 6 additions & 17 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,13 @@

## How To

### Prepare

- 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 [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/).

### Submit
- Make code changes in your fork and new branch
- Clean compile your changes on Windows or Linux and test basic simulator operations.
- When your pull request is created, you might get prompted to one-time sign [Contributor License Agreement (CLA)](https://en.wikipedia.org/wiki/Contributor_License_Agreement) unless changes are minor. It's very simple and takes less than a minute.
- If your pull request gets a conflict, please resolve it.
- If you pull request shows other changes you need to rebase your branch and try again.
- Watch for any comments on your pull request.


## Don'ts

- Do not make just cosmetic changes. We will generally reject pull requests with *only* cosmetic changes.
- Do not change code in the deps folder! That's our dependencies and untouchable unless there is very strong reason for it.
- Do not include OS specific header files. Large portions of our library is header-only and we want to keep all our headers clean.
- Do not make changes to very large number of files. We need to review every line of your change and we can't reasonably do that if you make requests with huge number of changes.
## Do and Don'ts
- Rebase your branch frequenty with master (once every 2-3 days is ideal).
- Use same style and formating 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.
3 changes: 2 additions & 1 deletion docs/who_is_using.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#### Would you like to see your own group or project here?
Just add a [GitHub issue](https://github.com/microsoft/airsim/issues) with quick details and link to your website or paper or send us email at msrair at microsoft.com.


* [NASA Ames Research Center – Systems Analysis Office](https://www.nasa.gov/ames)
* [Astrobotic](https://www.astrobotic.com/technology) - [Kerry Snyder](http://www.ohscope.com/)
* [GRASP Lab, Univ of Pennsylvania](https://www.grasp.upenn.edu/) - [Dr. Giuseppe Loianno](http://wpage.unina.it/giuseppe.loianno/)
* [Department of Aeronautics and Astronautics, Stanford University](https://aa.stanford.edu/) - [Prof. Mykel J. Kochenderfer](http://mykel.kochenderfer.com/)
Expand All @@ -15,3 +15,4 @@ Just add a [GitHub issue](https://github.com/microsoft/airsim/issues) with quick
* [HAMS project](https://www.microsoft.com/en-us/research/project/hams/), MSR India -[Venkat Padmanabhan](https://www.microsoft.com/en-us/research/people/padmanab/) and [Akshay Uttama Nambi](https://www.microsoft.com/en-us/research/people/t-snaksh/)
* [Texas A&M](https://www.tamu.edu/) - [Sai Vemprala](http://www.saihv.com/)
* [Robotics and Perception Group, University of Zurich](http://rpg.ifi.uzh.ch/) - [Davide Scaramuzza](http://rpg.ifi.uzh.ch/people_scaramuzza.html)

0 comments on commit 1a4a51b

Please sign in to comment.