|
| 1 | +## Changes |
| 2 | + |
| 3 | +You can find the complete Chartlets changelog |
| 4 | +[here](https://github.com/bcdev/chartlets/blob/main/CHANGES.md). |
| 5 | + |
| 6 | +## Reporting |
| 7 | + |
| 8 | +If you have suggestions, ideas, feature requests, or if you have identified |
| 9 | +a malfunction or error, then please |
| 10 | +[post an issue](https://github.com/bcdev/chartlets/issues). |
| 11 | + |
| 12 | +## Contributions |
| 13 | + |
| 14 | +The Chartlets project welcomes contributions of any form |
| 15 | +as long as you respect our |
| 16 | +[code of conduct](https://github.com/bcdev/chartlets/blob/main/CODE_OF_CONDUCT.md) |
| 17 | +and follow our |
| 18 | +[contribution guide](https://github.com/bcdev/chartlets/blob/main/CONTRIBUTING.md). |
| 19 | + |
| 20 | +If you'd like to submit code or documentation changes, we ask you to provide a |
| 21 | +pull request (PR) |
| 22 | +[here](https://github.com/bcdev/chartlets/pulls). |
| 23 | +For code and configuration changes, your PR must be linked to a |
| 24 | +corresponding issue. |
| 25 | + |
| 26 | +## Development |
| 27 | + |
| 28 | +To set up the Python development environment, with repository root as |
| 29 | +current working directory: |
| 30 | + |
| 31 | +```bash |
| 32 | +cd chartlets.py |
| 33 | +pip install .[dev,doc] |
| 34 | +``` |
| 35 | + |
| 36 | +### Testing and Coverage |
| 37 | + |
| 38 | +Chartlets uses [pytest](https://docs.pytest.org/) for unit-level testing |
| 39 | +and coverage analysis for its Python code. |
| 40 | + |
| 41 | +```bash |
| 42 | +cd chartlets.py |
| 43 | +pytest --cov=chartlets tests |
| 44 | +``` |
| 45 | + |
| 46 | +### Coding Style |
| 47 | + |
| 48 | +Chartlets' Python code is formatted by [black](https://black.readthedocs.io/). |
| 49 | + |
| 50 | +```bash |
| 51 | +cd chartlets.py |
| 52 | +black . |
| 53 | +``` |
| 54 | + |
| 55 | +Chartlets' TypeScript code is formatted by |
| 56 | +[prettier](https://prettier.io/). |
| 57 | + |
| 58 | +```bash |
| 59 | +cd chartlets.js |
| 60 | +prettier . |
| 61 | +``` |
| 62 | + |
| 63 | +### Documentation |
| 64 | + |
| 65 | +Chartlets' documentation is built using the [mkdocs](https://www.mkdocs.org/) tool. |
| 66 | + |
| 67 | +```bash |
| 68 | +cd chartlets.py |
| 69 | +pip install .[doc] |
| 70 | +cd .. |
| 71 | +``` |
| 72 | + |
| 73 | +With repository root as current working directory: |
| 74 | + |
| 75 | +```bash |
| 76 | +# Write |
| 77 | +mkdocs serve |
| 78 | + |
| 79 | +# Publish |
| 80 | +mkdocs build |
| 81 | +mkdocs gh-deploy |
| 82 | +``` |
| 83 | + |
| 84 | +## License |
| 85 | + |
| 86 | +Chartlets is open source made available under the terms and conditions of the |
| 87 | +[MIT License](https://github.com/bcdev/chartlets/blob/main/LICENSE). |
| 88 | + |
| 89 | +Copyright © 2024 Brockmann Consult Development |
0 commit comments