Contributing to Taipy
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.
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.
Several channels are open to communicate with the Taipy team:
- The taipy.io forum for open discussion with the Taipy team.
- GitHub issues on the
taipyrepository to suggest improvements, new features, or to report a bug.
- GitHub discussions on the
taipyrepository for discussing technical topics related to the implementation of Taipy.
- StackOverflow for precise questions related to the usage of Taipy.
Before contributing to Taipy, please read our Code of conduct.
Never contributed to an open source project before ?¶
Have a look at this GitHub documentation.
Reporting bugs is through GitHub issues.
Please report relevant information and preferably code that exhibits the problem. We provide templates to help you present the issue in a comprehensive way.
The Taipy team will analyze 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.
Feedback, proposal or any comment¶
Any feedback or proposal is greatly appreciated! Do not hesitate to create an issue with the appropriate template on GitHub.
The Taipy team will analyze your issue and return to you as soon as possible.
Do not hesitate to create an issue or pull request directly on the taipy-doc repository.
The Taipy team manages its backlog in private. Each issue that will be done during our current
sprint is attached to the
current sprint. Please, do not work on it, the Taipy team is on it.
Taipy is organized in several repositories:
- taipy brings previous packages in a single one.
All new development happens in the
develop branch. All pull requests should target that branch.
We are following a strict branch naming convention based on the pattern:
<type>would be one of:
- feature: new feature implementation, or improvement of a feature.
- fix: bug fix.
- review: change provoked by review comment not immediately taken care of.
- refactor: refactor of a piece of code.
- doc: doc changes (complement or typo fixes…).
- 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, dash-separated words. This summary, with its dash (‘-’) symbol prefix, is optional.
Find an issue without the label
current sprint and add a comment on it to inform the community
that you are working on it.
Make your own fork of the repository target by the issue. Clone it on our local machine, then go inside the directory.
We are working with Pipenv for our virtual environments. Create a local env and install development package by running
pipenv install --dev, then run tests with
pipenv run pytestto verify your setup.
For convention help, we provide a pre-commit file. This tool will run before each commit and will automatically reformat code or raise warnings and errors based on the code format or Python typing. You can install and setup it up by doing:
pipenv install pre-commit --skip-lock pipenv run python -m pre-commit install
Make the change and create a pull request from your fork. Keep your pull request in 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: - Include tests. - Code is rebase. - License is present. - pre-commit works - without MyPI errors. - GitHub's actions are passing.
The Taipy team will have a look at your Pull Request and will give feedback. If every requirement is valid, your work will be added in the next release, congratulation!
Taipy comes with multiple optional packages. You can find the list directly in the product or
Taipy's packages. The back-end Pipfile does not install by default optional packages due to
pyodbc requiring a driver's manual installation. This is not the behavior for the front-end
that installs all optional packages through its Pipfile.
If you are a contributor on Taipy, be careful with dependencies, do not forget to install or uninstall depending on your issue.
If you need to add to Taipy a new dependency, do not forget to add it in the
setup.py. Keep in mind that dependency is a vector of attack. The Taipy team limits the usage
of external dependencies at the minimum.