Skip to content

Commit 26cd6d5

Browse files
committed
#350 Contributing.md: more rephrasing, link to Discord server, link to page of integrators, ...
1 parent c5070a4 commit 26cd6d5

File tree

1 file changed

+24
-25
lines changed

1 file changed

+24
-25
lines changed

CONTRIBUTING.md

+24-25
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,48 @@
11
# Contributing
22

3-
Contributions are very much welcome! This can be in form of pull requests, issues, as well as providing opinions
4-
in existing issues—or on pull requests. If you have a nice project that integrates ConfigMe, let us know as that
5-
also helps us get a better picture of the way ConfigMe is being used.
3+
Contributions are very much welcome! This can be in form of pull requests, issues, providing opinions on existing issues
4+
or pull request reviews. Moreover, let us know if you have a nice project that can be added to the list of
5+
[integrators](https://github.com/AuthMe/ConfigMe/wiki/Integrators)—seeing ConfigMe "out in the wild" helps understand
6+
the needs and the pain points of users!
67

7-
ConfigMe is managed heavily based on GitHub issues, so you're very much invited to open a new issue also for
8-
[questions](https://github.com/AuthMe/ConfigMe/issues/126) or any other discussion points. Please discuss larger code
9-
changes first, either by creating an issue or by contacting the main maintainer, ljacqu (Discord: `cyrkel`).
8+
ConfigMe is managed heavily based on GitHub issues, so you're invited to open a new issue also for questions
9+
(like [#126](https://github.com/AuthMe/ConfigMe/issues/126)) or for any other discussion points. Please discuss larger
10+
code changes first, either by creating an issue or by writing in the [`#configme` channel](https://discord.com/channels/295623711485198357/1143605240520769547)
11+
of the AuthMe Discord server.
1012

1113
# General conventions
1214

13-
Ideally:
14-
- If you use IntelliJ, consider installing the Checkstyle plugin and configuring it to use the rules in
15-
`.checkstyle.xml` of this project's root.
16-
- Commit messages ideally start with the issue number they reference, e.g. `#229 Remove option to split map keys by "."`
17-
- Please use sensibly-sized commits (e.g. don't commit every change separately)
18-
- Use American English in code and comments (e.g. _initialize_, _color_)
15+
- If you're using IntelliJ, please install the Checkstyle plugin and configure it to use the rules from
16+
`.checkstyle.xml`, located in the project's root directory.
17+
- Commit messages ideally start with the issue number they relate to, e.g. `#229 Remove option to split map keys by "."`
18+
- Please use sensibly-sized commits (e.g. don't commit every change separately).
19+
- Use American English in code and comments: _initialize_, _color_, etc.
1920

20-
No sweat if some points aren't met since they can be addressed during pull request review, and we can squash
21-
pull requests when needed.
21+
No sweat if some points aren't met since they can be addressed in pull requests, and PRs can be squashed.
2222

2323
# Code style
2424

2525
Please try to match the current code style. A few pointers:
2626
- Indent with spaces, not tabs
27-
- Max line length is 120 (Checkstyle, mentioned above, should catch this)
27+
- Max line length is 120 (Checkstyle, mentioned above, should catch lines that are too long)
2828
- Do not use wildcard imports
2929
- Use camel-case as defined in the [Google Java style guide](https://google.github.io/styleguide/javaguide.html#s5.3-camel-case)
30-
(i.e. use `setHttpLink` and not `setHTTPLink`)
30+
(i.e. use names like `setHttpLink`, not `setHTTPLink`)
3131

3232
## Javadoc
3333

34-
- Use the third-person form of verbs and not the imperative (e.g. "Gets all properties" and not "Get all properties")
34+
- Use the third-person form of verbs and not the imperative: "Gets all properties" and not "Get all properties".
3535
- Avoid `@link` to common JDK types like `Map` or `String`. These types are visible from the method signature—manually
3636
linking them adds no value.
3737
- Try to provide context rather than just un-camel-case-ing the thing you're describing
3838
(e.g. "Gets the result" on a method "getResult" does not provide any additional information).
3939
- Do not close `<p>` tags in Javadoc text. This is in line with the JDK and Oracle's [recommendations](https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html#format).
4040
- Do not align parameter descriptions (in the form of `@param name     the name` because of
41-
another longer param name)
42-
- Please see existing Javadoc to see preferences for uppercase and lowercase, line breaks, etc.
41+
another longer param name).
42+
- Please refer to the existing Javadoc for preferences regarding casing, line breaks and similar.
4343

44-
Example:
45-
```
44+
Example of Javadoc on a method:
45+
```java
4646
/**
4747
* Creates a builder, using the given YAML file to use as property resource.
4848
*
@@ -52,7 +52,7 @@ Example:
5252
public static @NotNull SettingsManagerBuilder withYamlFile(@NotNull Path file) {
5353
```
5454

55-
Again: **no pressure** if some of these things are not met since they can be addressed afterwards :)
55+
However, there's **no pressure** if some of these things are not met since they can be addressed afterwards :)
5656
5757
## Unit tests
5858
@@ -62,6 +62,5 @@ Unit tests are written in BDD style. A normal test method:
6262
- has a section `// when` that calls the method to be tested
6363
- has a section `// then` that verifies the expected outcome
6464
65-
Best way to get a feel for the desired structure of a test method is to view the existing ones.
66-
67-
65+
Best way to get a feel for the desired structure of a test method is to view existing ones,
66+
such as the methods in `MigrationUtilsTest`.

0 commit comments

Comments
 (0)