Added detailed Contributing guideline (#191) #233
Conversation
PAException
force-pushed
the
issue/191
branch
2 times, most recently
from
a98a933
to
ba92cd1
Compare
|
|
||
| Great if you want to contribute to this project! | ||
|
|
||
| But we have to maintain this project and to do that easier everyone has to observe the follwing rules. |
There was a problem hiding this comment.
"we have"
that's not rly true, better would be "Our job as maintainers is to guarantee high code quality and standards, which makes it easier for other people, including us, to contribute to this project. Because of that everyone should follow certain rules while contributing to this project."
|
|
||
| ## Code Style | ||
|
|
||
| The code is written like the official [Java Code Conventions](https://www.oracle.com/technetwork/java/codeconventions-150003.pdf). |
There was a problem hiding this comment.
our code isn't written like some conventions - our conventions are somewhere similar to the oracle java code conventions
|
|
||
| The code is written like the official [Java Code Conventions](https://www.oracle.com/technetwork/java/codeconventions-150003.pdf). | ||
|
|
||
| Important is to give the methods and classes expressive and clear names to easily differentiate between them. |
There was a problem hiding this comment.
Use more titles, for example: ### Expressive method and class names
|
|
||
| Important is to give the methods and classes expressive and clear names to easily differentiate between them. | ||
|
|
||
| A command should be wrapped in a new line if it has more than 120 characters. |
There was a problem hiding this comment.
Command?
"Statement" is the word u are searching for
|
|
||
| A command should be wrapped in a new line if it has more than 120 characters. | ||
|
|
||
| Tab characters have to be used instead of spaces. |
There was a problem hiding this comment.
"As the standard indentation for code we use tabs"
| ControllerResult<SolutionModel> solutionResult = this.solutionController.getSolution(taskId); | ||
| ```` | ||
|
|
||
| DTOs are named if they are are requestDTO ``dto``, if it is a responseDTO they are called `responseDTO`. |
There was a problem hiding this comment.
duplicate "are" and the sentence is hard to understand bc of improper grammar
| - controller<br> | ||
| └ controller of endpoints | ||
| - database<br> | ||
| └ repositories of controllers and models of those repositories |
There was a problem hiding this comment.
and repositories have nothing to do with controllers - just models. Remember: We are using MVC, which separates these layers
| - database<br> | ||
| └ repositories of controllers and models of those repositories | ||
| - endpoint<br> | ||
| └ endpoint classes and response/request DTOs (**D**ata**T**ransfer**O**bject) |
There was a problem hiding this comment.
DTOs are in a sub-package of "endpoint"
| - endpoint<br> | ||
| └ endpoint classes and response/request DTOs (**D**ata**T**ransfer**O**bject) | ||
| - pubsub<br> | ||
| └ pubsub classes and subscriber/publisher for the [PubSubSystem](https://github.com/E-Edu/concept/blob/master/documentation/dev/architecture/architecture.md#pubsub-cluster) |
There was a problem hiding this comment.
plural for "subscriber/publisher"
There was a problem hiding this comment.
what do you mean exactly?
| - pubsub<br> | ||
| └ pubsub classes and subscriber/publisher for the [PubSubSystem](https://github.com/E-Edu/concept/blob/master/documentation/dev/architecture/architecture.md#pubsub-cluster) | ||
| - spring<br> | ||
| └ custom config files of spring |
|
|
||
| ## Issues | ||
|
|
||
| ##### Any Bugs, Feature Request or Improvements? |
|
|
||
| ##### Any Bugs, Feature Request or Improvements? | ||
|
|
||
| [Write us an issue!](https://github.com/E-Edu/task/issues/new/choose) |
There was a problem hiding this comment.
They won't write an issue to us, they create an issue
Closes #191