commit dda847607fc88ab6bb6d9646d52cd9795f7af0b3 Author: Sebastian Thiel Date: Fri Feb 27 10:22:03 2015 +0100 feat(all): initial commit Base project with everything it will need to grow: * CI * documentation * basic cargo diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000..c420590701 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +target +Cargo.lock +*.sublime-workspace diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000000..f2b20bfe3a --- /dev/null +++ b/.travis.yml @@ -0,0 +1,13 @@ +language: rust +after_success: | + [ $TRAVIS_BRANCH = master ] && + [ $TRAVIS_PULL_REQUEST = false ] && + cargo doc && + echo '' > target/doc/index.html && + git shortlog -s -n | cut -c 8- > target/doc/humans.txt && + sudo pip install ghp-import && + ghp-import -n target/doc && + git push -fq https://${TOKEN}@github.com/${TRAVIS_REPO_SLUG}.git gh-pages +env: + global: + secure: Plj5DqAQX/4+KPM+nOAZ2sCbGIsoSrHo1YggfesQnU7paR734XO/4IayWnsNO/3q6bDi4GIcn56RUZAD3xBJJBNLia2CYIickIIYORRqLWbLdbzQaxBbD670ahtzEuUSFJTRKURPwFteAnsWYgNMNzwXOVNwLS5IUBqWTcS+N0g= diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..5ae690c965 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,70 @@ +## Issues + +All issues, may it be feature requests, or bugs, are treated as **problems**. +In any case it is important to be able to reproduce or understand it. To help in doing so, please state the following information: + +* a description of the problem +* steps to reproduce the problem (if applicable) +* library version showing the problem (if applicable) + +The emphasis on the term **problem** originates from the observed tendency of issues being more like a solution to a problem, +which is not stated in detail, making good solutions more difficult to achieve. + +## Pull Requests + +Feel free to make any kind of Pull Request - all contributions are welcome. + +The only thing to keep in mind is the commit message format, which is described below. + +### Commit Message Format + +The format is taken directly from [angular.js][angular-contribution-guide], as is this text. + +Each commit message consists of a **header**, a **body** and a **footer**. The header has a special +format that includes a **type**, a **scope** and a **subject**: + +``` +(): + + + +