Writing contributing rules for this github project

[arthuRHD]

This project needs contributing rules to prevent anarchy if more people come to contribute.

Here's the list of things that should be done:

• Add a CONTRIBUTE.md file that describes how to make a PR and stuff
• Add issues templates for this categories: third-party integration, feature, documentation and bug #61
• Provides more information on how to use the project as a developer

[vasanthapeddinti]

Hello @arthuRHD , I would like to get started on contributing to open source projects and was trying to find a "good first issue" to start with. Can I pick this task of documentation?

Thanks
Vasantha

[arthuRHD]

Hi @vasanthapeddinti,

You are more than welcomed to do so, I'll assign you on this.
I'm here for any questions. 👍🏻

[arthuRHD]

Hi @vasanthapeddinti,

Are still working on it ?
Feel free to ask if you're facing issues. I can help you out.

[vasanthapeddinti]

@arthuRHD Sorry about the delay. I will try to make progress by this weekend and raise a pull request

[arthuRHD]

@vasanthapeddinti It's alright, don't pressure yourself 👌

It's actually my first publicly shared repository on Github. I want to set guidelines in order to help people contributing. I've contributed to projects before and I found myself getting overwhelmed when I was assigned on an issue.

I want to reduce the stress and clarify everything, so anyone can start with all needed informations.
Templates are great provided tools for that.

As I don't have much knowledge on this, I started searching in the documentation and the blog about it.
I found this : https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors

This is a great start if you're looking for knowledge.
Otherwise, I was planning on learning from templates used by popular repositories, such as FastAPI or React.

But I don't know, what would you do my friend ? 😄

[arthuRHD]

I like adding gitmoji inside the commit message, it's straight to the point ! https://gitmoji.dev/
Maybe we can ask people to format their commit messages in a certain way

For example:

:gitmoji: : commit message (#number of the PR)