Improve the contribution guide

pull/2007/head
Hugo Locurcio 2018-06-10 19:10:18 +02:00
parent cd0fe21464
commit 5f04cf09e7
No known key found for this signature in database
GPG Key ID: 39E8F8BE30B0A49C
1 changed files with 9 additions and 10 deletions

View File

@ -1,11 +1,10 @@
#How to contribute # How to contribute
If you want to contribute you can follow these setps: If you want to contribute, follow these steps:
- Fist create your own clone of assimp
- When you want to fix a bug or add a new feature create a branch on your own fork ( just follow https://help.github.com/articles/creating-a-pull-request-from-a-fork/ ) - First, create your own clone of assimp.
- Push it to the repo and open a pull request - When you want to fix a bug or add a new feature, create a branch on your own fork following [these instructions](https://help.github.com/articles/creating-a-pull-request-from-a-fork/).
- A pull request will start our CI-service, which checks if the build works for linux and windows. - Push it to your fork of the repository and open a pull request.
It will check for memory leaks, compiler warnings and memory alignment issues. If any of these tests fails: fix it and the tests will be reastarted automatically - A pull request will start our continuous integration service, which checks if the build works for Linux and Windows.
- At the end we will perform a code review and merge your branch to the master branch. It will check for memory leaks, compiler warnings and memory alignment issues. If any of these tests fail, fix it and the tests will be restarted automatically.
- At the end, we will perform a code review and merge your branch to the master branch.