From 2a92af5fbabdb8c34a29f4cae97e5a03ff2ca28c Mon Sep 17 00:00:00 2001 From: Tadej Lahovnik Date: Wed, 22 Nov 2023 08:12:00 +0100 Subject: [PATCH 1/2] doc: Contribution guide --- CONTRIBUTING.md | 85 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 85 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..be96871 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,85 @@ +# Contributing to Sport Activities Features +:+1::tada: First off, thanks for taking the time to contribute! :tada::+1: + +## Code of Conduct +This project and everyone participating in it is governed by the [Sport Activities Features Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [iztok.fister1@um.si](mailto:iztok.fister1@um.si). + +## How Can I Contribute? + +### Reporting Bugs +Before creating bug reports, please check existing issues list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible in the [issue template](.github/templates/ISSUE_TEMPLATE.md). + +### Suggesting Enhancements + +Open new issue using the [feature request template](.github/templates/FEATURE_REQUEST.md). + +### Pull requests + +Fill in the [pull request template](.github/templates/PULL_REQUEST.md) and make sure your code is documented. + +## Setup development environment + +### Requirements + +* Poetry: [https://python-poetry.org/docs](https://python-poetry.org/docs) + +After installing Poetry and cloning the project from GitHub, you should run the following command from the root of the cloned project: + +```sh +poetry install +``` + +All of the project's dependencies should be installed and the project ready for further development. **Note that Poetry creates a separate virtual environment for your project.** + +### Dependencies + +| Package | Version | Platform | +|------------|:-------:|:--------:| +| matplotlib | ^3.3.3 | All | +| geopy | ^2.0.0 | All | +| overpy | ^0.6 | All | +| geotiler | ^0.14.5 | All | +| numpy | 1.24 | All | +| tcxreader | ^0.4.4 | All | +| pandas | * | All | +| niaaml | ^1.1.12 | All | +| tcx2gpx | 0.1.4 | All | +| gpxpy | 1.4.2 | All | + +#### Development dependencies + +| Package | Version | Platform | +|---------|:--------:|:--------:| +| ruff | ^0.0.292 | Any | + +#### Test dependencies + +| Package | Version | Platform | +|------------|:--------:|:--------:| +| pytest | ^7.2.2 | Any | +| coveralls | ^2.2.0 | Any | + +#### Extras + +| Package | Version | Platform | +|----------------------|:-------:|:--------:| +| sphinx | ^4.4.0 | Any | +| sphinx-rtd-theme | ^1.0.0 | Any | + +## Development Tasks + +### Testing + +Manually run the tests: + +```sh +poetry run pytest +``` + +### Documentation + +Build the documentation: + +```sh +poetry run sphinx-build ./docs ./docs/_build +``` \ No newline at end of file From 20242f150ca1bf5b6d9f3f066c56356bc9fd1d7b Mon Sep 17 00:00:00 2001 From: Tadej Lahovnik Date: Wed, 22 Nov 2023 08:14:19 +0100 Subject: [PATCH 2/2] doc: Pull request template --- .github/templates/PULL_REQUEST.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/templates/PULL_REQUEST.md b/.github/templates/PULL_REQUEST.md index 7b22d87..dc9a473 100644 --- a/.github/templates/PULL_REQUEST.md +++ b/.github/templates/PULL_REQUEST.md @@ -11,4 +11,4 @@ If there's anything else that's important and relevant to your pull request, mention that information here. This could include benchmarks, or other information. -Thanks for contributing to NiaAML! \ No newline at end of file +Thanks for contributing to Sport Activities Features! \ No newline at end of file