Guide to contributing and a link in the readme

[Lucas-lufa]

I have used the contributing guide that we made for ocroo project.

Summary by Sourcery

Documentation:

• Add a contributor's guide and link it in the README

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request adds a 'Contributor's Guide' to the project and links it in the ReadMe file. The guide provides instructions for new contributors on how to fork the repository, keep their fork synchronized, create branches, write code, commit changes, push changes, create pull requests, and address feedback.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Added a link to the Contributor's Guide in the ReadMe file.	Added a line in the ReadMe file that links to the new Contributor's Guide.	ReadMe.md
Created a Contributor's Guide to help new contributors.	Created a new markdown file with instructions on how to contribute to the project. The guide covers forking, synchronizing, branching, coding, committing, pushing, creating pull requests, and addressing feedback.	Contributor's-Guide.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @Lucas-lufa - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider adding a table of contents to the contributor guide for easier navigation.

Here's what I looked at during the review

• 🟡 General issues: 2 issues found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[sourcery-ai]

suggestion (typo): Missing space after 'created'.

Add a space after 'created' for better readability.

Suggested change

	- Then switch to the new branch you created
	- Then switch to the new branch you created

[sourcery-ai]

suggestion (typo): Add a comma after 'First'.

Adding a comma after 'First' improves clarity: 'First, stage all your changed files...'

Suggested change

	- First stage all your changed files for commit
	- First, stage all your changed files for commit