Contribution guide on GitHub wiki

CarletonURocketry / ground-station

The ground station software used to interface with the ground station LoRa board and distribute signals from the rocket across websocket connections.

https://carletonurocketry.github.io/ground-station/

MIT License

7 stars 6 forks source link

Contribution guide on GitHub wiki #24

Closed linguini1 closed 1 year ago

linguini1 commented 1 year ago

In order to support new developers joining the team, the GitHub wiki should be updated with a contribution guide.

Steps to be outlined

How to create a branch/fork for development
How to verify workflow issues before creating a pull request (flake8, pyright, running tests, etc)
How to open a pull request and request reviews, etc
How to mention issues in a pull request so as to link resolutions appropriately

Optional (would be nice to have)

Feel free to add additional steps as you see fit, like how to write clear commit messages, how to rebase/merge main into a development branch, how to revert commits/amend commit messages, etc.

yr1404 commented 1 year ago

I'd like to work on this issue.

linguini1 commented 1 year ago

I'd like to work on this issue.

Hello! Are you a member of the CUInSpace design team at Carleton University?

yr1404 commented 1 year ago

Hello! Are you a member of the CUInSpace design team at Carleton University?

linguini1 commented 1 year ago

Hello! Are you a member of the CUInSpace design team at Carleton University?

No

Thank you for your interest in our project, but we're trying to keep contributions only to individuals at Carleton University who are part of the rocketry design team or have an interest in joining it.

linguini1 commented 1 year ago

Base contribution guideline has been added in PR #31, but more information about running workflows could be added.