Skip to content

Commit 32d1f0c

Browse files
authored
Create CONTRIBUTING.md -- document procedure (#45)
* Create CONTRIBUTING.md * update README
1 parent 86c74f2 commit 32d1f0c

File tree

2 files changed

+25
-12
lines changed

2 files changed

+25
-12
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Contributing Guidelines
2+
3+
## Procedure
4+
5+
1. *After* opening an issue and discussing with the development team, create a PR with the proposed changes.
6+
2. If [testing fails](https://github.com/uscuni/sgeop/actions/runs/11368511561) due to an update in the code base:
7+
3. Observed data is [saved as artifacts](https://github.com/uscuni/sgeop/actions/runs/11368511561#artifacts) from the workflow and can be download locally.
8+
4. We determine the `ci_artifacts-ubuntu-latest-py312_sgeop-latest` data as the "truth."
9+
5. After comparison of the current "known" data with new data from (3.), if new data is "truthier," update your PR with the new "known" data.
10+
11+
## Code Structure
12+
13+
Code should be linted and formatted via `ruff`. With the [`.pre-commit` hooks](https://github.com/uscuni/sgeop/blob/main/.pre-commit-config.yaml) we have code in commits will be formatted and linted automatically once [`pre-commit` is installed](https://pre-commit.com/#installation).

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,29 @@
22

33
[![Continuous Integration](https://github.com/uscuni/sgeop/actions/workflows/testing.yml/badge.svg)](https://github.com/uscuni/sgeop/actions/workflows/testing.yml) [![codecov](https://codecov.io/gh/uscuni/sgeop/graph/badge.svg?token=GFISMU0WPS)](https://codecov.io/gh/uscuni/sgeop)
44

5-
Street geometry processing toolkit
5+
## Introduction
6+
7+
## Documentation
8+
9+
## Examples
610

711
```py
812
import sgeop
913

1014
simplified = sgeop.simplify_network(gdf)
1115
```
1216

13-
This package developed & and maintained by:
14-
* [Martin Fleischmann](https://github.com/martinfleis)
15-
* [Anastassia Vybornova](https://github.com/anastassiavybornova)
16-
* [James D. Gaboardi](https://github.com/jGaboardi)
17-
18-
## Introduction
19-
20-
## Documentation
21-
22-
## Examples
23-
2417
## Contribution
2518

19+
See our guidelines in [`CONTRIBUTING.md`](https://github.com/uscuni/sgeop/CONTRIBUTING.md).
20+
2621
## Recommended Citation
2722

2823
---------------------------------------
2924

25+
This package developed & and maintained by:
26+
* [Martin Fleischmann](https://github.com/martinfleis)
27+
* [Anastassia Vybornova](https://github.com/anastassiavybornova)
28+
* [James D. Gaboardi](https://github.com/jGaboardi)
29+
3030
Copyright (c) 2024-, sgeop Developers

0 commit comments

Comments
 (0)