Devasy23 / FaceRec

An advanced facial recognition system designed for real-time identification using deep learning models and optimized vector search. Features include face detection, embedding generation, and scalable deployment options.
Apache License 2.0
31 stars 30 forks source link

[Documentation] : Enhancement Of Contributing.md #102

Open milansamuel609 opened 2 weeks ago

milansamuel609 commented 2 weeks ago

Issue Title

Enhancing the structure of contributing,md file

Type

Description

The contributing.md file is not in a structured manner. Also some sections are missing. I can enhance it in a well structured manner with proper details and some additional sections also that will make the contributors easier to contribute.

Expected Behavior

Current Behavior

The file is not having enough contents to help a freshly starting contributor.

Screenshots / Code Snippets (if applicable)

Environment

Possible Solution (if you have any in mind)

Wanted to do the following changes :-

1) Enhance the project structure 2) Add code of conduct section 3) Add star our repository section 4) Add need help with the basics section 5) Add first pull request steps section 6) Add additional method of contributing through GitHub desktop section 7) Add good coding practices section 8) Add the pull request rules section 9) Add the thank you section

Additional Information