diff --git a/README.md b/README.md index d67a0a6..e08dbf6 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # PyGeM [![Build Status](https://travis-ci.org/mathLab/PyGeM.svg)](https://travis-ci.org/mathLab/PyGeM) [![Coverage Status](https://coveralls.io/repos/github/mathLab/PyGeM/badge.svg?branch=master)](https://coveralls.io/github/mathLab/PyGeM?branch=master) Python Geometrical Morphing. -![Python Geometrical Morphing](docs/source/_static/logo_PyGeM_small.png) +![Python Geometrical Morphing](readme/logo_PyGeM_small.png) ## Description **PyGeM** is a python library using **Free Form Deformation** to parametrize and morph complex geometries. It is ideally suited for actual industrial problems, since it allows to handle: @@ -73,6 +73,48 @@ under the supervision of [Prof. Gianluigi Rozza](mailto:gianluigi.rozza@sissa.it Contact us by email for further information or questions about **PyGeM**, or suggest pull requests. **PyGeM** is at an early development stage, so contributions improving either the code or the documentation are welcome! +## How to contribute +We'd love to accept your patches and contributions to this project. There are +just a few small guidelines you need to follow. + +### Submitting a patch + + 1. It's generally best to start by opening a new issue describing the bug or + feature you're intending to fix. Even if you think it's relatively minor, + it's helpful to know what people are working on. Mention in the initial + issue that you are planning to work on that bug or feature so that it can + be assigned to you. + + 2. Follow the normal process of [forking][] the project, and setup a new + branch to work in. It's important that each group of changes be done in + separate branches in order to ensure that a pull request only includes the + commits related to that bug or feature. + + 3. To ensure properly formatted code, please make sure to use a tab of 4 + spaces to indent the code. You should also run [pylint][] over your code. + It's not strictly necessary that your code be completely "lint-free", + but this will help you find common style issues. + + 4. Any significant changes should almost always be accompanied by tests. The + project already has good test coverage, so look at some of the existing + tests if you're unsure how to go about it. We're using [coveralls][] that + is an invaluable tools for seeing which parts of your code aren't being + exercised by your tests. + + 5. Do your best to have [well-formed commit messages][] for each change. + This provides consistency throughout the project, and ensures that commit + messages are able to be formatted properly by various git tools. + + 6. Finally, push the commits to your fork and submit a [pull request][]. Please, + remember to rebase properly in order to maintain a clean, linear git history. + +[forking]: https://help.github.com/articles/fork-a-repo +[pylint]: https://www.pylint.org/ +[coveralls]: https://coveralls.io +[well-formed commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html +[pull request]: https://help.github.com/articles/creating-a-pull-request + + ## License See the [LICENSE](LICENSE.rst) file for license rights and limitations (MIT). diff --git a/docs/source/_static/logo_PyGeM_small.png b/readme/logo_PyGeM_small.png similarity index 100% rename from docs/source/_static/logo_PyGeM_small.png rename to readme/logo_PyGeM_small.png