CONTRIBUTING.md 3.36 KB
Newer Older
1
Contributing/Development [![Open Source Helpers](https://www.codetriage.com/dropwizard/dropwizard/badges/users.svg)](https://www.codetriage.com/dropwizard/dropwizard)
2
===
3

4 5 6 7 8 9 10 11 12 13
Dropwizard is always looking for people to contribute to the project. We welcome your
feedback and want to listen and discuss your ideas and issues.

There are many different ways to help contribute to the Dropwizard project.

* Helping others by participating in the [Dropwizard User Google Group](https://groups.google.com/forum/#!forum/dropwizard-user)
* Improving or enhancing our [documentation](http://dropwizard.github.io/dropwizard/)
* Fixing open issues listed in the [issue tracker](https://github.com/dropwizard/dropwizard/issues?state=open)
* Adding new features to the Dropwizard codebase

14 15
You can triage issues which may include reproducing bug reports or asking for vital information, such as version numbers or reproduction instructions. If you would like to start triaging issues, one easy way to get started is to [subscribe to dropwizard on CodeTriage](https://www.codetriage.com/dropwizard/dropwizard).

16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
Guidelines
===
When submitting a pull request, please make sure to fork the repository and create a
separate branch for your feature or fix for an issue.

All contributions are welcome to be submitted for review for inclusion, but before
they will be accepted, we ask that you follow these simple guidelines:

Code style
---
When submitting code, please make every effort to follow existing conventions and
style in order to keep the code as readable as possible. We realize that the style
used in Dropwizard might be different that what is used in your projects, but in the end
 it makes it easier to merge changes and maintain in the future.

Testing
---
We kindly ask that all new features and fixes for an issue should include any unit tests.
Even if it is small improvement, adding a unit test will help to ensure no regressions or the
issue is not re-introduced. If you need help with writing a test for your feature, please
don't be shy and ask!

Documentation
---
Up-to-date documentation makes all our lives easier. If you are adding a new feature,
enhancing an existing feature, or fixing an issue, please add or modify the documentation
as needed and include it with your pull request.

New Features
===
If you would like to implement a new feature, please raise an issue before sending a
pull request so the feature can be discussed. **We appreciate the effort and want
to avoid a situation where a contribution requires extensive rework on either side,
it sits in the queue for a long time, or cannot be accepted at all.**
50

51 52
Developer List
===
53 54
The Google Group [dropwizard-dev](https://groups.google.com/forum/#!forum/dropwizard-dev)
is the place to discuss everything to do with the development of the framework itself,
55 56 57
including docs, process and community management.


58 59
Feel free to post questions about internals, ideas for new features or refactorings,
different strategies, requests for comment/review etc. This is the forum for everyone
60 61
who wants to actively contribute to the project itself.

62 63 64 65 66 67
Committers
===
The list of people with committer access is kept in the developer section of the pom.xml located in the parent directory.

* Committers aren't allowed to merge their own changes, the exception being bug fixes
* A commit may be reverted, but it requires 2+ committer's approval. The goal is to keep it democratic