docs: Add contributing.md file

[emmaaroche]

Description

Added a new CONTRIBUTING.md file that documents how to contribute to the Kuadrant testsuite repository.

The guide includes the following sections:

• Contributing Guidelines
• Forking the Repository
• Coding Rules / Guidelines
• Reformat, Commit Acceptance & Cleanup
• Committing Changes & Opening a Pull Request

Please feel free to suggest any additional content or improvements during review.

Closes #823

[averevki]

Looks great Emma 👍 Just a small nit

[fabikova]

Hi Emma, it looks very nice! I added a suggestion about encouraging use of git commit --amend to avoid cluttering the history with "fix" commits. And using git push --force-with-lease when updating a branch after rebasing/amending to prevent accidental overwrites.

[silvi-t]

Thank you @emmaaroche for doing this contributing file. Just a general question: is it necessary to add every single git command to this file? Shouldn't the user know that, for example, staging changes in git is git add or how to fork the repository?

[emmaaroche]

@silvi-t I think including the commands helps keep contributions consistent and also makes the expected workflow clear for new contributors. It is not meant to teach Git or anything, just to document the specific workflow this repository follows 😄

[silvi-t]

@silvi-t I think including the commands helps keep contributions consistent and also makes the expected workflow clear for new contributors. It is not meant to teach Git or anything, just to document the specific workflow this repository follows 😄

Got it, thanks! I see your point. It's more detailed than I would do, but I understand it makes the workflow clear. No problem from my side! 👍

[trepel]

Very nice!

Given there's quite detailed git/GitHub workflow described, I would add to it (myself, in a separate PR, and only if you think it's worth having it there) that you can disallow pushing to "upstream" by executing:
git remote set-url --push upstream no_push

If you take a look at the remote repositories you can see that you can only push to "origin" (your fork):

git remote -v
origin	git@github.com:trepel/testsuite.git (fetch)
origin	git@github.com:trepel/testsuite.git (push)
upstream	git@github.com:Kuadrant/testsuite.git (fetch)
upstream	no_push (push)

[emmaaroche]

Thanks @trepel, I think that would be good to add! I can update this PR, will just require re-approval then

[averevki]

Just to add context, our main branch is push protected and you won't be able to push anything there without creating a pull request. So section with git remote set-url --push upstream no_push doesn't seem essential here

P.S. also not a fan of describing git workflow in contribution doc but could be I guess

[emmaaroche]

Just to add context, our main branch is push protected and you won't be able to push anything there without creating a pull request. So section with git remote set-url --push upstream no_push doesn't seem essential here

P.S. also not a fan of describing git workflow in contribution doc but could be I guess

Thanks @averevki. I’ve merged it as discussed so we have an initial version in place, and we can definitely discuss and iterate on it from here.