From e23565b3f8939e7caa70a96ddf1bee59fbc63b12 Mon Sep 17 00:00:00 2001 From: Kozakowski Karol Date: Wed, 2 Mar 2016 15:43:06 +0100 Subject: [PATCH] CONTRIBUTING.md and .gitignore --- .gitignore | 3 +++ CONTRIBUTING.md | 38 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 41 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/.gitignore b/.gitignore index 7eb39d3d..69b4a326 100644 --- a/.gitignore +++ b/.gitignore @@ -39,3 +39,6 @@ coverage/ .tmp/ .librarian/ +# log directory +log/ + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..2642dd5f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,38 @@ +If you follow these contributing guidelines your patch +will likely make it into a release a little quicker. + + +## Contributing + +1. Fork the repo. + +2. Create your feature branch (`git checkout -b feature/my-new-feature`) + +3. Run the tests. We only take pull requests with passing tests, and + it's great to know that you have a clean slate + +4. Add a test for your change. Only refactoring and documentation + changes require no new tests. If you are adding functionality + or fixing a bug, please add a test. + +5. Make the test pass. + +6. Push to your fork and submit a pull request. + + +## Dependencies + +All dependencies are listed in Puppetfile + +## Syntax and style + +There is integrated link task in Rakefile that depends on metadata-json-lint to lint metadata.json + +## Running the unit tests + +To run tests suits you need to have `bundler`. To install all necessary gems use `bundle install` in root folder of project. + +To see available test tasks use: `bundle exec rake -T`. + +## Integration tests +Integration tests are made with `beaker` and `vagrant`.