From 73105cb38940f56bf87c4defb048b0849654e0ca Mon Sep 17 00:00:00 2001 From: Dmitry Krivaltsevich Date: Mon, 26 Jun 2017 17:36:54 +0200 Subject: [PATCH 1/2] #23 created CONTRIBUTING.md --- CONTRIBUTING.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5947541 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,47 @@ +# Contributing to Play-zhewbacca + +**Thank you for your interest in making `play-zhewbacca` even better and more awesome. Your contributions are highly welcome.** + +There are multiple ways of getting involved: + +- [Report a bug](#report-a-bug) +- [Suggest a feature](#suggest-a-feature) +- [Contribute code](#contribute-code) + +Below are a few guidelines we would like you to follow. +If you need help, please reach out to us: team-stt@zalando.de + +## Report a bug +Reporting bugs is one of the best ways to contribute. Before creating a bug report, please check that an [issue](https://github.com/zalando-incubator/play-zhewbacca/issues) reporting the same problem does not already exist. If there is an such an issue, you may add your information as a comment. + +To report a new bug you should open an issue that summarizes the bug and set the label to "bug". + +If you want to provide a fix along with your bug report: That is great! In this case please send us a pull request as described in section [Contribute Code](#contribute-code). + +## Suggest a feature +To request a new feature you should open an [issue](https://github.com/zalando-incubator/play-zhewbacca/issues/new) and summarize the desired functionality and its use case. Set the issue label to "feature". + +## Contribute code +This is a rough outline of what the workflow for code contributions looks like: +- Check the list of open [issues](https://github.com/zalando-incubator/play-zhewbacca/issues). Either assign an existing issue to yourself, or create a new one that you would like work on and discuss your ideas and use cases. +- Fork the repository on GitHub +- Create a topic branch from where you want to base your work. This is usually master. +- Make commits of logical units. +- Write good commit messages (see below). +- Push your changes to a topic branch in your fork of the repository. +- Submit a pull request to [zalando-incubator/play-zhewbacca](https://github.com/zalando-incubator/play-zhewbacca) +- Your pull request must receive a :thumbsup: from two [Maintainers](https://github.com/zalando-incubator/play-zhewbacca/blob/master/MAINTAINERS) + +Thanks for your contributions! + +### Code style +The code will be automatically formatted every time when you make a build (`sbt clean compile`). Please run it on your code before making a pull request. The local build may fail with a message descriptive message in case of violations of our style guideline. + +### Commit messages +Your commit messages ideally can answer two questions: what changed and why. The subject line should feature the “what” and the body of the commit should describe the “why”. + +Please start every commit message with a issue number, for example `#123 fix for bug`. + +When creating a pull request, its comment should reference the corresponding issue id. + +**Have fun and enjoy hacking!** From 6f7ac9c246d10a9da235d8f91c42aa7abc2aee4a Mon Sep 17 00:00:00 2001 From: Dmitry Krivaltsevich Date: Tue, 27 Jun 2017 10:37:19 +0200 Subject: [PATCH 2/2] #23 improved text for code style --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5947541..74c12fe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,7 +35,7 @@ This is a rough outline of what the workflow for code contributions looks like: Thanks for your contributions! ### Code style -The code will be automatically formatted every time when you make a build (`sbt clean compile`). Please run it on your code before making a pull request. The local build may fail with a message descriptive message in case of violations of our style guideline. +The code will be automatically formatted every time when you make a build (`sbt clean compile`). Please run it locally before making a pull request. The local build may fail with a descriptive message in case of violations of our style guideline. ### Commit messages Your commit messages ideally can answer two questions: what changed and why. The subject line should feature the “what” and the body of the commit should describe the “why”.