Version 1.1.0 is slated to be the next release...

[ZZ-Cat]

Overview

I am trying something slightly different, this time around.

I have created two branches:

• 1.0.x-Maintenance-Branch
• 1.1.0-Development-Branch

I am doing it this way, to try and keep those pigeons (the ones what insist on flying by swinging their heads around in circles instead of using their wings) well-and-truly out of the way of the Main-Trunk.

Yes. I use the pigeon analogy to describe janky, messy, and untested code. Deal with it. 😎

1.0.x-Maintenance-Branch

This branch is where Pull Requests containing bug fixes to Version 1.0.0 will be merged.
Releases cut from this branch will be made as-and-when at least one fix is complete, tested, and verified things are working the way it SHOULD work.

The PATCH number will increase in accordance with the Semantic Versioning Standard.

Releases will be cut from this branch until Version 1.1.0 is released.
After that, this branch will be archived (IE marked "Read-Only") for six months. Once that six months has passed, this branch will be deleted.

1.1.0-Development-Branch

This is the mainstream branch where development on Version 1.1.0 will take place.
All Pull Requests regarding Version 1.1.0 will be merged to this branch.

When development of Version 1.1.0 is complete, this branch will be merged into the Main-Trunk, and a cut will be made to the Releases section.

What this means for you, as a contributor

Coders and code-base contributors

When you fork CRSF for Arduino, it is RECOMMENDED that you create your own branches off of the relevant branches above.
If you have spotted one (or more) bugs in the release of Version 1.0.0, consider basing your bug-fix branch off the 1.0.x-Maintenance-Branch and ensure your Pull Request is targeting this branch.
If you wish to contribute to the development of Version 1.1.0, consider basing your particular branch off of 1.1.0-Development-Branch and ensure your Pull Request is targeting this branch.

If I see that your Pull Request is either targeting the Main-Trunk or another branch that is not relevant, I will ask you to re-base your branch to the one specified, and on a case-by-case basis.

Hardware Testers

The branches above do not necessarily apply to you, until you're contributing directly to the code-base.
With this being said, I am putting a call out to the community here, and letting you all know that I need folks what can help out with testing CRSF for Arduino on your hardware.

At this point, do what you need to do.
Here's some pointers of what I need:

• Currently, all of CRSF for Arduino's targets (barring the Adafruit Metro M4 Express) is untested.
• Unit testing on supported targets is strongly RECOMMENDED. Although, if you're unable to do this, don't fret.
• Simply building, flashing, and running on your hardware and submitting Issues (if you spot any bugs) is enough, if this is all you're able to do, because this helps me and my other contributors out a tonne.

With over 150 hardware targets in the Compatibility Table, it isn't feasible for me alone to test every single possible development board. So, I am relying on you all - my user-base, to help me out here.

At this point, help out when and wherever you're able to.
Because the more hands I can get onto this project, the better.

Issues or Discussions, which one do I pick

Okay, I need to address this publicly.
I see some of you are getting your wires crossed with my Issues tab and Discussions Tab.
If you happen across a bug, or something in the code-base is not working the way it's supposed to, this is where you go to my Issues tab, click "Create new Issue", click "Submit a bug report", fill out the form and describe the bug you have encountered, plus the steps I require to recreate the bug on my end. Remember to provide as much relevant details as you can here, as this helps to speed-up the debugging process - IE Me or my contributors aren't needing to figure it out for ourselves in regards to the issue you're having.

The Discussions tab is not for submitting bug reports. Please keep bug reports OUT of my Discussions tab.
If I see any more bug reports in the Discussions tab, I will create an Issue from your report and delete your post from the Discussions. Also, I may or may not... no wait... that's too unprofessional for GitHub. 😆

Also, please try to make use of the threads in the Discussions to keep conversations coherent, relevant and easier for me to follow. Someone in particular kept creating new threads in one of my Discussions and it was all over the place. I could not keep up with this person, because they didn't keep to one thread with their discussion with my contributors and I.
Like, dude. I know you're heart's in the right place. But, dayum! Way to make a girl feel like a kitten chasing a laser pointer. 😅