-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Thibault Meyer <[email protected]>
- Loading branch information
0 parents
commit f3070e7
Showing
9 changed files
with
485 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# editorconfig.org | ||
|
||
root = true | ||
|
||
[*] | ||
charset = utf-8 | ||
end_of_line = lf | ||
indent_size = 2 | ||
indent_style = space | ||
insert_final_newline = true | ||
trim_trailing_whitespace = true | ||
spaces_around_operators = true | ||
|
||
[*.java] | ||
indent_size = 4 | ||
|
||
[*.xml] | ||
indent_size = 4 | ||
|
||
[*.yml] | ||
indent_size = 4 | ||
|
||
[*.md] | ||
trim_trailing_whitespace = false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
*.class | ||
*.java~ | ||
|
||
|
||
# IntelliJ IDEA | ||
.idea/ | ||
*.iml | ||
|
||
|
||
# Other IDE | ||
.classpath | ||
.project | ||
.settings | ||
|
||
|
||
# Package Files # | ||
*.jar | ||
target/ | ||
/test | ||
|
||
|
||
# MacOS / Windows | ||
.DS_Store | ||
Thumbs.db | ||
ehthumbs.db | ||
ehthumbs_vista.db | ||
*.lnk | ||
|
||
|
||
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml | ||
hs_err_pid* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
language: java | ||
|
||
jdk: | ||
- oraclejdk11 | ||
|
||
script: | ||
- mvn compile | ||
- mvn test |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,122 @@ | ||
# Contribution Guidelines | ||
|
||
## Introduction | ||
|
||
This document explains how to contribute changes to the play-rconf project. | ||
|
||
|
||
|
||
|
||
## Bug reports | ||
|
||
Please search the issues on the issue tracker with a variety of keywords to | ||
ensure your bug is not already reported. | ||
|
||
If unique, [open an issue](https://github.com/play-rconf/play-rconf-http/issues) and answer the questions | ||
so we can understand and reproduce the problematic behavior. | ||
|
||
The burden is on you to convince us that it is actually a bug in | ||
play-remote-configuration. This is easiest to do when you write clear, concise | ||
instructions so we can reproduce the behavior (even if it seems obvious). The | ||
more detailed and specific you are, the faster we will be able to help you. | ||
Check out [How to Report Bugs Effectively](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html). | ||
|
||
Please be kind, remember that play-remote-configuration comes at no cost to you, | ||
and you're getting free help. | ||
|
||
|
||
|
||
|
||
## Code review | ||
|
||
Changes to play-remote-configuration must be reviewed before they are accepted, | ||
no matter who makes the change even if it is an owner or a maintainer. We use | ||
GitHub's pull request workflow to do that. | ||
|
||
Please try to make your pull request easy to review for us. Please read the | ||
"[How to get faster PR reviews](https://github.com/kubernetes/community/blob/master/contributors/guide/pull-requests.md)" guide, it has lots of | ||
useful tips for any project you may want to contribute. Some of the key points: | ||
|
||
* Make small pull requests. The smaller, the faster to review and the more | ||
likely it will be merged soon. | ||
* Don't make changes unrelated to your PR. Maybe there are typos on some | ||
comments, maybe refactoring would be welcome on a function... but if that | ||
is not related to your PR, please make *another* PR for that. | ||
* Split big pull requests in multiple small ones. An incremental change will | ||
be faster to review than a huge PR. | ||
|
||
|
||
|
||
|
||
## Sign your work | ||
|
||
The sign-off is a simple line at the end of the explanation for the patch. Your | ||
signature certifies that you wrote the patch or otherwise have the right to pass | ||
it on as an open-source patch. | ||
|
||
``` | ||
Signed-off-by: John Smith <[email protected]> | ||
``` | ||
|
||
Please use your real name, we really dislike pseudonyms or anonymous | ||
contributions. We are in the opensource world without secrets. If you have set | ||
your `user.name` and `user.email`, you can sign your commit automatically | ||
with `git commit -s`. | ||
|
||
|
||
|
||
|
||
## Write a good commit message | ||
|
||
A good commit message serve at least three important purposes: | ||
|
||
* To speed up the reviewing process. | ||
|
||
* To help us write a good release note. | ||
|
||
* To help the future maintainers of play-remote-configuration, say five years | ||
into the future, to find out why a particular change was made to the code or | ||
why a specific feature was added. | ||
|
||
Structure your commit message like this: | ||
|
||
From: [[http://git-scm.com/book/ch5-2.html]] | ||
|
||
> ``` | ||
> Short (50 chars or less) summary of changes | ||
> | ||
> More detailed explanatory text, if necessary. Wrap it to about 72 | ||
> characters or so. In some contexts, the first line is treated as the | ||
> subject of an email and the rest of the text as the body. The blank | ||
> line separating the summary from the body is critical (unless you omit | ||
> the body entirely); tools like rebase can get confused if you run the | ||
> two together. | ||
> | ||
> Further paragraphs come after blank lines. | ||
> | ||
> - Bullet points are okay, too | ||
> | ||
> - Typically a hyphen or asterisk is used for the bullet, preceded by a | ||
> single space, with blank lines in between, but conventions vary here | ||
> ``` | ||
#### DO | ||
* Write the summary line and description of what you have done in the imperative | ||
mode, that is as if you were commanding someone. Start the line with "Fix", | ||
"Add", "Change" instead of "Fixed", "Added", "Changed". | ||
* Always leave the second line blank. | ||
* Line break the commit message (to make the commit message readable without | ||
having to scroll horizontally in `gitk`). | ||
#### DON'T | ||
* Don't end the summary line with a period - it's a title and titles don't end | ||
with a period. | ||
#### Tips | ||
* If it seems difficult to summarize what your commit does, it may be because | ||
it includes several logical changes or bug fixes, and are better split up | ||
into several commits using `git add -p`. | ||
#### References | ||
The following blog post has a nice discussion of commit messages: | ||
http://chris.beams.io/posts/git-commit/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2018 The Play Remote Configuration Authors | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# Play Remote Configuration - GIT | ||
|
||
|
||
Retrieves configuration hosted on a GIT repository | ||
***** | ||
|
||
## About this project | ||
In production, it is not always easy to manage the configuration files of a | ||
Play Framework application, especially when it running on multiple servers. | ||
The purpose of this project is to provide a simple way to use a remote | ||
configuration with a Play Framework application. | ||
|
||
|
||
|
||
## How to use | ||
|
||
To enable this provider, just add the classpath `"io.playrconf.provider.GitProvider"` | ||
and the following configuration: | ||
|
||
```hocon | ||
remote-configuration { | ||
## Provider - GIT | ||
# ~~~~~ | ||
# Retrieves configuration hosted on a GIT repository | ||
git { | ||
} | ||
} | ||
``` | ||
|
||
|
||
## License | ||
This project is released under terms of the [MIT license](https://raw.githubusercontent.com/play-rconf/play-rconf-git/master/LICENSE). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
<?xml version="1.0"?> | ||
|
||
<!DOCTYPE suppressions PUBLIC | ||
"-//Puppy Crawl//DTD Suppressions 1.0//EN" | ||
"http://www.puppycrawl.com/dtds/suppressions_1_0.dtd"> | ||
|
||
<suppressions> | ||
</suppressions> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,92 @@ | ||
<?xml version="1.0"?> | ||
<!DOCTYPE module PUBLIC | ||
"-//Puppy Crawl//DTD Check Configuration 1.2//EN" | ||
"http://www.puppycrawl.com/dtds/configuration_1_2.dtd"> | ||
<module name="Checker"> | ||
<module name="NewlineAtEndOfFile"> | ||
<property name="lineSeparator" value="lf"/> | ||
</module> | ||
<module name="FileLength"/> | ||
<module name="FileTabCharacter"/> | ||
<module name="RegexpSingleline"> | ||
<property name="format" value="\s+$"/> | ||
<property name="message" value="Line has trailing spaces."/> | ||
</module> | ||
<module name="RegexpMultiline"> | ||
<property name="format" value="\r?\n[\t ]*\r?\n[\t ]*\r?\n"/> | ||
<property name="message" value="Unnecessary consecutive lines"/> | ||
</module> | ||
<module name="RegexpSingleline"> | ||
<property name="format" value="/\*\* +\p{javaLowerCase}"/> | ||
<property name="fileExtensions" value="java"/> | ||
<property name="message" value="First sentence in a comment should start with a capital letter"/> | ||
</module> | ||
<module name="RegexpMultiline"> | ||
<property name="format" value="/\*\*\W+\* +\p{javaLowerCase}"/> | ||
<property name="fileExtensions" value="java"/> | ||
<property name="message" value="First sentence in a comment should start with a capital letter"/> | ||
</module> | ||
<module name="TreeWalker"> | ||
<module name="ConstantName"/> | ||
<module name="LocalFinalVariableName"/> | ||
<module name="LocalVariableName"/> | ||
<module name="MemberName"/> | ||
<module name="MethodName"/> | ||
<module name="MethodLength"/> | ||
<module name="PackageName"/> | ||
<module name="ParameterName"/> | ||
<module name="StaticVariableName"/> | ||
<module name="TypeName"/> | ||
<module name="IllegalImport"/> | ||
<module name="UnusedImports"> | ||
<property name="processJavadoc" value="true"/> | ||
</module> | ||
<module name="LineLength"> | ||
<property name="max" value="180"/> | ||
</module> | ||
<module name="GenericWhitespace"/> | ||
<module name="EmptyForIteratorPad"/> | ||
<module name="MethodParamPad"/> | ||
<module name="NoWhitespaceAfter"> | ||
<property name="tokens" value="BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS, UNARY_PLUS"/> | ||
</module> | ||
<module name="NoWhitespaceBefore"/> | ||
<module name="OperatorWrap"/> | ||
<module name="ParenPad"/> | ||
<module name="OneTopLevelClass"/> | ||
<module name="TypecastParenPad"/> | ||
<module name="WhitespaceAfter"/> | ||
<module name="WhitespaceAround"/> | ||
<module name="LeftCurly"/> | ||
<module name="RightCurly"/> | ||
<module name="CovariantEquals"/> | ||
<module name="EmptyStatement"/> | ||
<module name="EqualsAvoidNull"/> | ||
<module name="EqualsHashCode"/> | ||
<module name="IllegalInstantiation"/> | ||
<module name="MissingSwitchDefault"/> | ||
<module name="SimplifyBooleanExpression"/> | ||
<module name="SimplifyBooleanReturn"/> | ||
<module name="InterfaceIsType"/> | ||
<module name="FinalClass"/> | ||
<module name="ArrayTypeStyle"/> | ||
<module name="UpperEll"/> | ||
<module name="FinalParameters"/> | ||
<module name="ArrayTrailingComma"/> | ||
<module name="DeclarationOrder"/> | ||
<module name="DefaultComesLast"/> | ||
<module name="ExplicitInitialization"/> | ||
<module name="FallThrough"/> | ||
<module name="FinalLocalVariable"/> | ||
<module name="HiddenField"> | ||
<property name="ignoreConstructorParameter" value="true"/> | ||
<property name="ignoreSetter" value="true"/> | ||
<property name="setterCanReturnItsClass" value="true"/> | ||
</module> | ||
<module name="IllegalThrows"/> | ||
<module name="IllegalToken"/> | ||
<module name="IllegalTokenText"/> | ||
<module name="IllegalType"/> | ||
<module name="InnerAssignment"/> | ||
</module> | ||
</module> |
Oops, something went wrong.