proveskit / circuitpy_flight_software

Flight software for the PROVES Kit.
MIT License
2 stars 4 forks source link

Initial python linter #23

Closed nateinaction closed 1 month ago

nateinaction commented 1 month ago

Hey team,

This PR adds

This looks like a big PR but all python modifications were performed by Black and were not made by a human.

In the future I'd like to implement more advanced static analysis that will help us detect and prevent bugs as well as automated testing frameworks for both the python and cpp codebases.

When this PR is merged, I'd like to restrict the main branch from being merged to directly. All changes will require PRs and all PRs will need to pass testing.

I also suggest that we consider blocking pull requests on reviews. Pull requests can serve as documentation for why a change was made and reviews can ensure that at least one other person knows what the change does.

Mikefly123 commented 1 month ago

Your recommendations on restricting merging to main on reviewed Pull Requests sounds good to me as well!

I have also been meaning to setup a real versioning system for our software as well. Probably out of the scope of this PR but we can look at that in the next few days!

nateinaction commented 1 month ago

@Mikefly123 Thanks for being open to these changes! I've implemented the branch rules to restrict changes to pull requests and ensure that the lint check is passing. I'll hold off on requiring peer reviews until we have a chance to talk about it in the next software meeting.