浏览代码

propagate changes on shared file.

jrobinAV 2 年之前
父节点
当前提交
f86b207630
共有 1 个文件被更改,包括 19 次插入14 次删除
  1. 19 14
      CONTRIBUTING.md

+ 19 - 14
CONTRIBUTING.md

@@ -3,8 +3,8 @@
 Thanks for your interest in helping improve Taipy! Contributions are welcome, and they are greatly appreciated!
 Thanks for your interest in helping improve Taipy! Contributions are welcome, and they are greatly appreciated!
 Every little help and credit will always be given.
 Every little help and credit will always be given.
 
 
-There are multiple ways to contribute to Taipy, code, but also reporting bugs, creating feature requests, helping
-other users in our forums, Stack Overflow, etc.
+There are multiple ways to contribute to Taipy: code, but also reporting bugs, creating feature requests, helping
+other users in our forums, [stack**overflow**](https://stackoverflow.com/), etc.
 
 
 Today the only way to communicate with the Taipy team is by GitHub issues.
 Today the only way to communicate with the Taipy team is by GitHub issues.
 
 
@@ -17,7 +17,7 @@ Have a look on this [GitHub documentation](https://docs.github.com/en/get-starte
 Reporting bugs is through [GitHub issues](https://github.com/Avaiga/taipy/issues).
 Reporting bugs is through [GitHub issues](https://github.com/Avaiga/taipy/issues).
 
 
 Please report relevant information and preferably code that exhibits the problem. We provide templates to help you
 Please report relevant information and preferably code that exhibits the problem. We provide templates to help you
-to present the issue in a comprehensive way.
+describe the issue.
 
 
 The Taipy team will analyse and try to reproduce the bug to provide feedback. If confirmed, we will add a priority
 The Taipy team will analyse and try to reproduce the bug to provide feedback. If confirmed, we will add a priority
 to the issue and add it in our backlog. Feel free to propose a pull request to fix it.
 to the issue and add it in our backlog. Feel free to propose a pull request to fix it.
@@ -41,8 +41,9 @@ attached to the `current sprint`. Please, do not work on it, the Taipy team is o
 
 
 ## Code organisation
 ## Code organisation
 
 
-Taipy is organised in four main repositories:
+Taipy is organised in five main repositories:
 
 
+- [taipy-config](https://github.com/Avaiga/taipy-config).
 - [taipy-core](https://github.com/Avaiga/taipy-core).
 - [taipy-core](https://github.com/Avaiga/taipy-core).
 - [taipy-gui](https://github.com/Avaiga/taipy-gui).
 - [taipy-gui](https://github.com/Avaiga/taipy-gui).
 - [taipy-rest](https://github.com/Avaiga/taipy-rest).
 - [taipy-rest](https://github.com/Avaiga/taipy-rest).
@@ -55,10 +56,10 @@ Taipy is organised in four main repositories:
 Taipy's repositories follow the [PEP 8](https://www.python.org/dev/peps/pep-0008/) and
 Taipy's repositories follow the [PEP 8](https://www.python.org/dev/peps/pep-0008/) and
 [PEP 484](https://www.python.org/dev/peps/pep-0484/) coding convention.
 [PEP 484](https://www.python.org/dev/peps/pep-0484/) coding convention.
 
 
-## Javascript
+## TypeScript
 
 
-Taipy's repositories follow the [W3Schools](https://www.w3schools.com/js/js_conventions.asp) and
-[Google](https://google.github.io/styleguide/tsguide.html) coding convention.
+Taipy's repositories use the [ESLint](https://eslint.org/) and
+[TypeScript ESLint](https://github.com/typescript-eslint/typescript-eslint) plugin to ensure a common set of rules.
 
 
 ### Git branches
 ### Git branches
 
 
@@ -69,7 +70,7 @@ Where:
 
 
 - `<type>` would be one of:
 - `<type>` would be one of:
     - feature: new feature implementation, or improvement of a feature.
     - feature: new feature implementation, or improvement of a feature.
-    - fix: bug fix.
+    - bug: bug fix.
     - review: change provoked by review comment not immediately taken care of.
     - review: change provoked by review comment not immediately taken care of.
     - refactor: refactor of a piece of code.
     - refactor: refactor of a piece of code.
     - doc: doc changes (complement or typo fixes…).
     - doc: doc changes (complement or typo fixes…).
@@ -97,15 +98,19 @@ working on it.
    code format or Python typing.
    code format or Python typing.
    You can install and setup it up by doing:
    You can install and setup it up by doing:
    ```
    ```
-     pipenv install pre-commit --skip-lock
+     pipenv install pre-commit
      pipenv run python -m pre-commit install
      pipenv run python -m pre-commit install
    ```
    ```
 
 
-4. Make the change and create a
-   [pull request from your fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork).
-   Keep your pull request in __draft__ until your work is finished.
+4. Make the changes.<br/>
+   You may want to also add your GitHub login as a new line of the `contributors.txt` file located at the root
+   of this repository. We are using it to list our contributors in the Taipy documentation
+   (see the "Contributing > Contributors" section) and thank them.
+
+5. Create a [pull request from your fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork).<br/>
+   Keep your pull request as __draft__ until your work is finished.
    Do not hesitate to add a comment for help or questions.
    Do not hesitate to add a comment for help or questions.
-   Before you submit a pull request read to review from your forked repo, check that it meets these guidelines:
+   Before you submit a pull request for review from your forked repo, check that it meets these guidelines:
     - Include tests.
     - Include tests.
     - Code is [rebase](http://stackoverflow.com/a/7244456/1110993).
     - Code is [rebase](http://stackoverflow.com/a/7244456/1110993).
     - License is present.
     - License is present.
@@ -125,6 +130,6 @@ installation. This is not the behaviour for the front-end that installs all opti
 If you are a contributor on Taipy, be careful with dependencies, do not forget to install or uninstall depending on
 If you are a contributor on Taipy, be careful with dependencies, do not forget to install or uninstall depending on
 your issue.
 your issue.
 
 
-If you need to add to Taipy a new dependency, do not forget to add it in the `Pipfile` and the `setup.py`.
+If you need to add a new dependency to Taipy, do not forget to add it in the `Pipfile` and the `setup.py`.
 Keep in mind that dependency is a vector of attack. The Taipy team limits the usage of external dependencies at the
 Keep in mind that dependency is a vector of attack. The Taipy team limits the usage of external dependencies at the
 minimum.
 minimum.