docs: Added Installation Instruction and CONTRIBUTING.md

Him7n commented 9 months ago

Pull Request: Add INSTALL.md and CONTRIBUTING.md

Pull Request Description:

This pull request introduces two new essential files to the repository: INSTALL.md and CONTRIBUTING.md. These files will provide valuable information to users and contributors to streamline the process of setting up the development environment and contributing to the project.

Changes Made:

INSTALL.md

Added a comprehensive guide for installing Python on Windows, MacOS, and Linux, helping users set up their development environments efficiently.
Included instructions for adding Python to the PATH on Windows to ensure a smooth user experience.
Offered additional information on installing Python for various Linux distributions.

CONTRIBUTING.md

Created a comprehensive guide for potential contributors, including instructions on reporting bugs, suggesting enhancements, and making code contributions.
Included guidelines for setting up the development environment, forking the repository, creating branches, making changes, and committing code.
Provided essential information on submitting a pull request and the code review process.
Detailed guidelines on commit message formatting.

By merging this pull request, you'll make it easier for new users and potential contributors to engage with the project, ultimately fostering collaboration and growth.

Thank you for considering these additions!

Resolves #6

rootCircle commented 9 months ago

Great Job @Him7n! I really like descriptive PR like these ones! For now on, I have signed in the Contributing Guidelines.

rootCircle commented 9 months ago

I have put in some review @Him7n . Please check them out, do let me know if you need any help regarding anything!

Him7n commented 9 months ago

I've made the required changes . Please check them out :)

rootCircle commented 9 months ago

LGTM :+1: Merged! Congrats on your PR! :tada:

rootCircle / codemark-cli