Skip to content
Snippets Groups Projects
Commit 88356e2e authored by Laurent Destailleur's avatar Laurent Destailleur
Browse files

Add a new rule on contributing when adding a new table.

parent 8068d01c
No related branches found
No related tags found
No related merge requests found
...@@ -4,7 +4,7 @@ How to contribute to Dolibarr ...@@ -4,7 +4,7 @@ How to contribute to Dolibarr
Bug reports and feature requests Bug reports and feature requests
-------------------------------- --------------------------------
<a name=not-a-support-forum></a>*Note*: Issues are not a support forum. If you need help using the software, please use [the forums](http://www.dolibarr.org/forum). <a name="not-a-support-forum"></a>*Note*: Issues are not a support forum. If you need help using the software, please use [the forums](http://www.dolibarr.org/forum).
Issues are managed on [GitHub](https://github.com/Dolibarr/dolibarr/Issues). Issues are managed on [GitHub](https://github.com/Dolibarr/dolibarr/Issues).
...@@ -13,9 +13,9 @@ Issues are managed on [GitHub](https://github.com/Dolibarr/dolibarr/Issues). ...@@ -13,9 +13,9 @@ Issues are managed on [GitHub](https://github.com/Dolibarr/dolibarr/Issues).
4. Tell us the version you are using! 4. Tell us the version you are using!
3. Write a report with as much detail as possible (Use [screenshots](https://help.github.com/articles/issue-attachments) or even screencasts and provide logging and debugging informations whenever possible). 3. Write a report with as much detail as possible (Use [screenshots](https://help.github.com/articles/issue-attachments) or even screencasts and provide logging and debugging informations whenever possible).
We're still figuring out how to migrate old issues to GitHub. In the meantime, they are still available at [Doliforge](https://doliforge.org/projects/dolibarr).
<a name=code></a>Code
<a name="code"></a>Code
--------------------- ---------------------
### Basic workflow ### Basic workflow
...@@ -26,7 +26,7 @@ We're still figuring out how to migrate old issues to GitHub. In the meantime, t ...@@ -26,7 +26,7 @@ We're still figuring out how to migrate old issues to GitHub. In the meantime, t
4. Commit and push your changes. 4. Commit and push your changes.
5. [Make a pull request](https://help.github.com/articles/creating-a-pull-request). 5. [Make a pull request](https://help.github.com/articles/creating-a-pull-request).
### <a name=branches></a>Branches ### <a name="branches"></a>Branches
Unless you're fixing a bug, all pull requests should be made against the *develop* branch. Unless you're fixing a bug, all pull requests should be made against the *develop* branch.
...@@ -40,7 +40,7 @@ Choose your base branch accordingly. ...@@ -40,7 +40,7 @@ Choose your base branch accordingly.
### General rules ### General rules
Please don't edit the ChangeLog file. File will be generated from your commit messages during release process by the project manager. Please don't edit the ChangeLog file. File will be generated from your commit messages during release process by the project manager.
### <a name=commits></a>Commits ### <a name="commits"></a>Commits
Use clear commit messages with the following structure: Use clear commit messages with the following structure:
``` ```
...@@ -98,8 +98,11 @@ If your pull request only contains one commit, GitHub will be smart enough to fi ...@@ -98,8 +98,11 @@ If your pull request only contains one commit, GitHub will be smart enough to fi
Otherwise, please be a bit verbose about what you're providing. Otherwise, please be a bit verbose about what you're providing.
Your Pull Request must pass the Continuous Integration checks. Your Pull Request must pass the Continuous Integration checks.
Also, if you want to include a new external library (into htdocs/includes directory), please ask before to the project Also, some code changes need a prior approbation:
leader to see if such a library can be accepted.
* if you want to include a new external library (into htdocs/includes directory), please ask before to the project leader to see if such a library can be accepted.
* if you add a new table, you must first create a page on http://wiki.dolibarr.org/index.php/Category:Table_SQL (copy an existing page changing its name to see it into this index page). Than ask the project leader if the new data model you plan to add can be accepted as you suggest.
### Resources ### Resources
[Developer documentation](http://wiki.dolibarr.org/index.php/Developer_documentation) [Developer documentation](http://wiki.dolibarr.org/index.php/Developer_documentation)
......
...@@ -149,6 +149,10 @@ These are features that Dolibarr does **not** yet fully support: ...@@ -149,6 +149,10 @@ These are features that Dolibarr does **not** yet fully support:
Administrator, user, developer and translator's documentations are available along with other community resources on the [Wiki](http://wiki.dolibarr.org). Administrator, user, developer and translator's documentations are available along with other community resources on the [Wiki](http://wiki.dolibarr.org).
## CONTRIBUTING
See file [CONTRIBUTING](https://github.com/Dolibarr/dolibarr/blob/develop/CONTRIBUTING.md)
## CREDITS ## CREDITS
Dolibarr is the work of many contributors over the years and uses some fine libraries. Dolibarr is the work of many contributors over the years and uses some fine libraries.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment