Skip to content

Latest commit

 

History

History
148 lines (104 loc) · 7.38 KB

CONTRIBUTING.md

File metadata and controls

148 lines (104 loc) · 7.38 KB
Raw

Contributions

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, stackoverflow, etc.

For questions, please get in touch on Discord or on GitHub with a discussion or an issue.

Code organisation

Taipy is organised in two main repositories:

  • taipy is the main repository that containing the code of Taipy packages.
  • taipy-doc is the documentation repository.

Never contributed on an open source project before ?

Have a look on this GitHub documentation.

Report bugs

Reporting bugs is through GitHub issues.

Please report relevant information and preferably code that exhibits the problem. We provide templates to help you describe the issue.

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.

Issue reporting, feedback, proposal, design or any other 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 analyse your issue and return to you as soon as possible.

Improve Documentation

Do not hesitate to create an issue or pull request directly on the taipy-doc repository.

Implement Features

The Taipy team manages its backlog in private. Each issue that is or is going to be engaged by the Taipy team is attached to the "🔒 Staff only" label or has already assigned to a Taipy team member. Please, do not work on it, the Taipy team is on it.

All other issues are sorted by labels and are available for a contribution. If you are new to the project, you can start with the "good first issue" or "🆘 Help wanted" label. You can also start with issue with higher priority like "Critical" or "High". The higher the priority, the more value it will bring to Taipy.

If you want to work on an issue, please add a comment and wait to be assigned to the issue to inform the community that you are working on it.

Contribution workflow

  1. Make your own fork of the repository target by the issue. Clone it on our local machine, then go inside the directory.

  2. We are working with Pipenv for our virtualenv. Create a local env and install development package by running $ pipenv install --dev, then run tests with $ pipenv run pytest to verify your setup.

  3. 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
$ pipenv run python -m pre-commit install

  4. Make the changes.
    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.
    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 for review from your forked repo, check that it meets these guidelines:

    • The code and the branch name follow the Taipy coding style.
    • Include tests.
    • Code is rebase.
    • License is present.
    • pre-commit works - without mypy error.
    • Taipy tests are passing.

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

Coding style and best practices

Python

Taipy's repositories follow the PEP 8 and PEP 484 coding convention.

TypeScript

Taipy's repositories use the ESLint and TypeScript ESLint plugin to ensure a common set of rules.

Git branches

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>/#<issueId>[IssueSummary].

Where:

  • <type> would be one of:
    • feature: new feature implementation, or improvement of a feature.
    • bug: 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.

Important Notes

  • If your PR is not created or there is no other activity within 14 days of being assigned to the issue, a warning message will appear on the issue, and the issue will be marked as "🥶Waiting for contributor".
  • If your issue is marked as "🥶Waiting for contributor", you will be unassigned after 14 days of inactivity.
  • Similarly, if there is no activity within 14 days of your PR, the PR will be marked as "🥶Waiting for contributor".
  • If your PR is marked as "🥶Waiting for contributor", it will be closed after 14 days of inactivity.

We do this in order to keep our backlog moving quickly. Please don't take it personally if your issue or PR gets closed because of this 14-day inactivity time limit. You can always reopen the issue or PR if you're still interested in working on it.

Dependency management

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