Skip to content

Commit

Permalink
fix: remove the test, contributing, and code of conduct sections from…
Browse files Browse the repository at this point in the history
… the package long description
  • Loading branch information
trgiangdo committed Jun 3, 2024
1 parent 6496202 commit 404685d
Show file tree
Hide file tree
Showing 6 changed files with 1 addition and 170 deletions.
26 changes: 1 addition & 25 deletions package_desc.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ built-in scheduling, and deployment tools.
or production planning.

- **Version Management and Pipeline Orchestration:** It includes tools for managing
application versions, pipeline versions, and data versions, which are beneficial
application versions, pipeline versions, and data versions, which are beneficial
for multi-user environments.

## Installation
Expand All @@ -59,27 +59,3 @@ pip install taipy
To install Taipy on a Conda Environment or from source code, please refer to the
[Installation Guide](https://docs.taipy.io/en/latest/installation/).<br />
To get started with Taipy, please refer to the [Getting Started Guide](https://docs.taipy.io/en/latest/getting_started/).

## Contributing

Writing code isn’t the only way to contribute to Taipy. You can also:
- help us stay on top of new and old issues
- develop tutorials, presentations, and other educational materials
- maintain and improve [our website](https://www.taipy.io) and [documentation](https://docs.taipy.io/en/latest/)
- review pull requests
- help with outreach and onboard new contributors

For more information about the ways you can contribute to Taipy, visit our
[Contributing Guide](https://docs.taipy.io/en/latest/contributing/contributing/).
If you’re unsure where to start or how your skills fit in, reach out on Discord. You can also ask on
GitHub, by opening a new issue or leaving a comment on a relevant issue that is already open.

If you are new to contributing to open source projects, [this guide](https://opensource.guide/how-to-contribute/)
helps explain why, what, and how to successfully get involved.

## Code of conduct

Taipy is an open source project developed by the Taipy development team and a community of
[contributors](https://docs.taipy.io/en/latest/contributing/contributors/). Please check out the
[Taipy Code of Conduct](https://docs.taipy.io/en/latest/contributing/code_of_conduct/) for guidance
on how to interact with others in a way that makes our community thrive.
29 changes: 0 additions & 29 deletions taipy/config/package_desc.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,32 +45,3 @@ git clone https://github.com/Avaiga/taipy.git

This creates the 'taipy' directory holding all the package's source code, and the 'taipy-config'
source code is in the 'taipy/config' directory.

## Running the tests

To run the tests on the package, you need to install the required development packages.
We recommend using [Pipenv](https://pipenv.pypa.io/en/latest/) to create a virtual environment
and install the development packages.

```bash
pip install pipenv
pipenv install --dev
```

Then you can run *taipy-config* tests with the following command:

```bash
pipenv run pytest tests/config
```

## Contributing

Want to help build *Taipy Config*? Check out our
[Contributing Guide](https://docs.taipy.io/en/latest/contributing/contributing/).

## Code of conduct

Taipy is an open source project developed by the Taipy development team and a community of
[contributors](https://docs.taipy.io/en/latest/contributing/contributors/). Please check out the
[Taipy Code of Conduct](https://docs.taipy.io/en/latest/contributing/code_of_conduct/) for guidance
on how to interact with others in a way that makes our community thrive.
29 changes: 0 additions & 29 deletions taipy/core/package_desc.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,32 +42,3 @@ git clone https://github.com/Avaiga/taipy.git

This creates the 'taipy' directory holding all the package's source code, and the 'taipy-core'
source code is in the 'taipy/core' directory.

## Running the tests

To run the tests on the package, you need to install the required development packages.
We recommend using [Pipenv](https://pipenv.pypa.io/en/latest/) to create a virtual environment
and install the development packages.

```bash
pip install pipenv
pipenv install --dev
```

Then you can run *taipy-core* tests with the following command:

```bash
pipenv run pytest tests/core
```

## Contributing

Want to help build *Taipy Core*? Check out our
[Contributing Guide](https://docs.taipy.io/en/latest/contributing/contributing/).

## Code of conduct

Taipy is an open source project developed by the Taipy development team and a community of
[contributors](https://docs.taipy.io/en/latest/contributing/contributors/). Please check out the
[Taipy Code of Conduct](https://docs.taipy.io/en/latest/contributing/code_of_conduct/) for guidance
on how to interact with others in a way that makes our community thrive.
29 changes: 0 additions & 29 deletions taipy/gui/package_desc.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,32 +108,3 @@ pip install -e . --user
```

This should install the dev version of Taipy GUI as editable. You are now ready to use it.

## Running the tests

To run the tests on the package, you need to install the required development packages.
We recommend using [Pipenv](https://pipenv.pypa.io/en/latest/) to create a virtual environment
and install the development packages.

```bash
pip install pipenv
pipenv install --dev
```

Then you can run *taipy-gui* tests with the following command:

```bash
pipenv run pytest tests/gui
```

## Contributing

Want to help build *Taipy GUI*? Check out our
[Contributing Guide](https://docs.taipy.io/en/latest/contributing/contributing/).

## Code of conduct

Taipy is an open source project developed by the Taipy development team and a community of
[contributors](https://docs.taipy.io/en/latest/contributing/contributors/). Please check out the
[Taipy Code of Conduct](https://docs.taipy.io/en/latest/contributing/code_of_conduct/) for guidance
on how to interact with others in a way that makes our community thrive.
29 changes: 0 additions & 29 deletions taipy/rest/package_desc.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,32 +142,3 @@ heroku container:release web
```

You can now access *taipy-rest* on the URL that was returned on the `heroku create` command.

## Running the tests

To run the tests on the package, you need to install the required development packages.
We recommend using [Pipenv](https://pipenv.pypa.io/en/latest/) to create a virtual environment
and install the development packages.

```bash
pip install pipenv
pipenv install --dev
```

Then you can run *taipy-rest* tests with the following command:

```bash
pipenv run pytest tests/rest
```

## Contributing

Want to help build *Taipy REST*? Check out our
[Contributing Guide](https://docs.taipy.io/en/latest/contributing/contributing/).

## Code of conduct

Taipy is an open source project developed by the Taipy development team and a community of
[contributors](https://docs.taipy.io/en/latest/contributing/contributors/). Please check out the
[Taipy Code of Conduct](https://docs.taipy.io/en/latest/contributing/code_of_conduct/) for guidance
on how to interact with others in a way that makes our community thrive.
29 changes: 0 additions & 29 deletions taipy/templates/package_desc.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,32 +59,3 @@ git clone https://github.com/Avaiga/taipy.git

This creates the 'taipy' directory holding all the package's source code, and the 'taipy-templates'
source code is in the 'taipy/templates' directory.

## Running the tests

To run the tests on the package, you need to install the required development packages.
We recommend using [Pipenv](https://pipenv.pypa.io/en/latest/) to create a virtual environment
and install the development packages.

```bash
pip install pipenv
pipenv install --dev
```

Then you can run *taipy-templates* tests with the following command:

```bash
pipenv run pytest tests/templates
```

## Contributing

Want to help build *taipy-templates*? Check out our
[Contributing Guide](https://docs.taipy.io/en/latest/contributing/contributing/).

## Code of conduct

Taipy is an open source project developed by the Taipy development team and a community of
[contributors](https://docs.taipy.io/en/latest/contributing/contributors/). Please check out the
[Taipy Code of Conduct](https://docs.taipy.io/en/latest/contributing/code_of_conduct/) for guidance
on how to interact with others in a way that makes our community thrive.

0 comments on commit 404685d

Please sign in to comment.