search

3dgeo-heidelberg / pytreedb

Python package providing a file and object-based database to store tree objects.
Other
28 stars 4 forks source link

Contributing #57

Closed han16nah closed 2 years ago

han16nah commented 2 years ago

Add CONTRIBUTING.md created from this template

solves #48

Once we are happy and merge this PR, we should also link to CONTRIBUTING.md in the README

lwiniwar commented 2 years ago

I would suggest to reduce complexity in the PR part by using the github web interface:

1) Fork the repository using the web interface 2) Clone and edit locally or edit online 3) Create a PR using the web interface: grafik 4) Ensure it is up to date using the PR interface ("fetch updates")

For me, this is much more straightforward than adding a remote source in the repo, especially if I only want to contribute once (e.g. fixing a typo, ...)

lwiniwar commented 2 years ago

I would also add the commands to run pytest and make sure that contributers understand that we repeat these tests upon PR submission (by means of github actions), and are only able/willing to merge if they pass

han16nah commented 2 years ago

I would also add the commands to run pytest and make sure that contributers understand that we repeat these tests upon PR submission (by means of github actions), and are only able/willing to merge if they pass

Yes, good suggestion, we can even explain the usage of the markers, e.g. to only run tests related to importing data etc. :)

han16nah commented 2 years ago

I would suggest to reduce complexity in the PR part by using the github web interface:

1. Fork the repository using the web interface

2. Clone and edit locally or edit online

3. Create a PR using the web interface:
   ![grafik](https://user-images.githubusercontent.com/24376088/166003095-3104a0b8-1300-4801-acd0-ea1515c68a5b.png)

4. Ensure it is up to date using the PR interface ("fetch updates")

For me, this is much more straightforward than adding a remote source in the repo, especially if I only want to contribute once (e.g. fixing a typo, ...)

Okay sure, I agree! :)