... | ... | @@ -2,14 +2,34 @@ |
|
|
|
|
|
As it's a public place, we should be careful not to cause too much disorder. To this end, we have agreed on certain rules.
|
|
|
|
|
|
## Feel Free and welcome to open issue !
|
|
|
|
|
|
If needed, you can be inspired by those models to report a bug or to propose your suggestions efficiently.
|
|
|
|
|
|
## Specification change
|
|
|
#### How to report a bug
|
|
|
|
|
|
* **Summary** : *What's the problem?*
|
|
|
* **Step to reproduce** : *How can we reproduce your bug ?*
|
|
|
* **Expected results** : *What did you expect to get ?*
|
|
|
* **Actual results** : *What do we have so far ?*
|
|
|
* **More info** : *Describe all the elements of your configuration that seem to you relevent sush as your OS, your browser, your size screen..*
|
|
|
|
|
|
#### How to make a suggestion ?
|
|
|
|
|
|
* **Description** : *What are the reasons of your suggestion ? No not hesitate to add image support.*
|
|
|
* **Proposal** : *Explain your suggestion. Explain what you were expecting ? In your dream, which behavior did you expect ? No not hesitate to add image support.*
|
|
|
* **Additional linked **: *Do you have examples or references for your suggestion ?*
|
|
|
|
|
|
#### For Specification change proposal
|
|
|
|
|
|
Before making any change to a software that requires a specification updcate, please open an issue explaining why there is a need to do so. If possible, provide an example use case. If you think of a solution, you can provide it with a code example.
|
|
|
|
|
|
This issue *should* be shared with all the other contributors so that every one can discuss it, until a decision is made. Then new issues should be created to describe the technical details of implementation.
|
|
|
|
|
|
#### Think about new timers
|
|
|
|
|
|
If you see an issue which seems to you really easy and not urgent, you can let it to the new timers add a label "new timers only".
|
|
|
|
|
|
## Commit messages
|
|
|
|
|
|
Please prefix your commit message with the level of modification which can be :
|
... | ... | @@ -27,6 +47,18 @@ update: configurable fields (fix #6) |
|
|
feature: representation of foreign keys as objects (fix #5)
|
|
|
feature: Federation model (fix #7)
|
|
|
```
|
|
|
## Take care of the documentation
|
|
|
|
|
|
We all know how document our work is important. If you find that you can add an improvement, the community is grateful to you!
|
|
|
|
|
|
#### Document your component
|
|
|
|
|
|
As we are smart and lazy, you can use [our documentation model for component](./Documentation Component Model) to be efficient.
|
|
|
|
|
|
#### Experimental feature
|
|
|
Every non experimental features *should* be documented in the repository README.md.
|
|
|
|
|
|
Experimental features *can* be documented, but their documentation should mention clearly that the feature is experimental and is not guaranteed to continue to work in the future.
|
|
|
|
|
|
## Make beautiful release note
|
|
|
|
... | ... | @@ -40,8 +72,3 @@ An experimental feature is not guaranteed to work fully as expected, nor is it g |
|
|
|
|
|
|
|
|
|
|
|
## Take care of the documentation
|
|
|
|
|
|
Every non experimental features *should* be documented in the repository README.md.
|
|
|
|
|
|
Experimental features *can* be documented, but their documentation should mention clearly that the feature is experimental and is not guaranteed to continue to work in the future. |
|
|
\ No newline at end of file |