Create a Contribution.md file

[opllama2]

The repo should have a CONTRIBUTION.md file that lists how to setup on a local machine and the workflow to take when working on any changes related to this repo.

[mohamedluay]

I guess installation and usage guide should go to the README.md file as it is part from the usage documentation, not something for contribution. For the workflow and how to contribute to the project as well as the do’s and don’t s then yes that should be placed in the contribution guide.

[opllama2]

i think the reason for confusion here is that the steps for setting-up for development and setting-up for usage are basically the same. i can move them to the readme to make it a bit more clear and create a link in the contributions file instead, and any extra setup steps for development can be mentioned here.

[ahmadalfy]

Thanks @opllama2 for your help, I think we will need to update the usage part in the README.MD as @mohamedluay mentioned in development we need to highlight that you only need install the dependencies if you're adding any new one 😄 otherwise you can just jump in the code and it will work.

Can I ask you to check this MD Linter for VSCode and apply its comments to the PR?

Thank you.

[opllama2]

@ahmadalfy thanks for pointing out that plugin, i will remove the install step as well, are we thinking of using something like commitlint and husky to ensure that commits are in conventional commit format ?

[ahmadalfy]

@opllama2 good idea to add in the future

[opllama2]

the PR is updated now