Contributing and checking commits

[StaticRocket]

Add a short file detailing how one can contribute to the project.

Add a commit check for PRs to make sure they are following the rules outlined in the CONTRIBUTING document.

Resolves #6 Resolves #10

[StaticRocket]

@nmenon

[cshilwant]

Hmm, Looks like conventional commit doesn't like more than 1 colon in commit message title - https://github.com/TexasInstruments/processor-sdk-doc/actions/runs/11524739733/attempts/1#summary-32085557172

[cshilwant]

The bots looks super strict - https://github.com/StaticRocket/processor-sdk-doc/actions/runs/11526783806/attempts/1#summary-32091486204

Has a restriction in branch name as well

[nmenon]

I must say, I LOVE IT!

[StaticRocket]

Yeah, but that's more for filtering branches on the primary repo, which there shouldn't really be anything other than master unless we decide to do some massive work that requires multiple contributions.

[nmenon]

Probably not on this commit, but we should consider adding something like https://blog.alta3.com/topics/scm-and-pipelines/adding-spell-checking-as-a-github-action/ -> I wonder if github enterprise has a paid service for grammar and spell check

[cshilwant]

Yeah, but that's more for filtering branches on the primary repo, which there shouldn't really be anything other than master unless we decide to do some massive work that requires multiple contributions.

I was referring to the branch names it expects from the author creating PRs as well. Branches must begin with these types: bugfix/ feature/ release/ hotfix/

[nmenon]

Also, please edit $subject line of PR: s/Contibuting/Contributing so that the merge message looks clean.

[StaticRocket]

I wonder if github enterprise has a paid service for grammar and spell check

I was thinking about that, but considering all the acronyms and odd names we'd definitely need to make our own dictionary for it to be useful. That being said, if we actually did make an acronym and odd word dict, it would make for good appendix fodder.