Enhance Documentation & Development Experience

[Michael-Obele]

Pull Request Information

What kind of change does this PR introduce?

Documentation improvements and developer experience enhancements.

Issue Number:

*Closes #14: Project documentation on GitHub. This pull request introduces a CONTRIBUTING guide as requested in issue #14.

Screenshots/videos:

N/A (This pull request focuses on documentation and configuration changes.)

If relevant, did you update the documentation?

Yes, this pull request introduces a new CONTRIBUTING.md file and updates the README.md file.

Summary

This pull request improves the project's documentation and development experience in several ways:

• Comprehensive CONTRIBUTING Guide: Provides clear instructions for contributing to the project, including reporting bugs, suggesting features, and making pull requests.
• Enhanced README: Expands the README.md to offer a more thorough introduction to the project and simplifies local development setup.
• Improved Developer Experience: Reduces unnecessary spell check warnings for Visual Studio Code users.

These changes aim to empower contributors, improve project understanding, and streamline development workflows.

Does this PR introduce a breaking change?

No, this pull request does not introduce any breaking changes.

[DhairyaMajmudar]

Hello @Michael-Obele left some changes, pls. once have a look on them : )

[Michael-Obele]

Hello @Michael-Obele left some changes, pls. once have a look on them : )

Hi @DhairyaMajmudar, Sure thing. I just made some changes; if you have time, please take a look and let me know if there is anything else I should change.