Skip to content
This repository has been archived by the owner on Feb 15, 2024. It is now read-only.

Commit

Permalink
propagate changes on shared file.
Browse files Browse the repository at this point in the history
  • Loading branch information
jrobinAV committed Apr 4, 2023
1 parent 2a339fd commit 11924ab
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Contributions

Thanks for your interest in helping improve Taipy! Contributions are welcome, and they are greatly appreciated!
Every little helps 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**](https://stackoverflow.com/), etc.
Expand Down Expand Up @@ -41,8 +41,9 @@ attached to the `current sprint`. Please, do not work on it, the Taipy team is o

## 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-gui](https://github.com/Avaiga/taipy-gui).
- [taipy-rest](https://github.com/Avaiga/taipy-rest).
Expand All @@ -57,7 +58,8 @@ Taipy's repositories follow the [PEP 8](https://www.python.org/dev/peps/pep-0008

## TypeScript

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.
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

Expand All @@ -75,7 +77,7 @@ Where:
- build: in relation with the build process.
- `<issueId>` is the processed issue identifier. The advantage of explicitly indicating the issue number is that in
GitHub, a pull request page shows a direct link to the issue description.
- `[IssueSummary]` is a short summary of the issue topic, not including spaces, using camel case or lower-case,
- `[IssueSummary]` is a short summary of the issue topic, not including spaces, using Camel case or lower-case,
dash-separated words. This summary, with its dash (‘-’) symbol prefix, is optional.


Expand All @@ -100,11 +102,15 @@ working on it.
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.
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.
- Code is [rebase](http://stackoverflow.com/a/7244456/1110993).
- License is present.
Expand Down

0 comments on commit 11924ab

Please sign in to comment.