Merge pull request #291 from noir-cr/update-contributing-md

Update CONTRIBUTING.md

CONTRIBUTING.md

@@ -1,12 +1,23 @@
-## ❤️ Contribute
-1. Write code in forked repo
-2. Make Pull Request to `dev` branch
-3. Finish :D
+# ❤️ Contribution Guidelines
+
+Thank you for considering contributing to our project! Here are some guidelines to help you get started and ensure a smooth contribution process.
+
+1. Fork and Code
+- Begin by forking the repository.
+- Write your code within your forked repository.
+
+3. Pull Request
+- Once your contribution is ready, create a Pull Request (PR) to the dev branch of the main repository.
+- Provide a clear and concise description of your changes in the PR.
+
+4. Completion
+- That's it! You're done. Await feedback and further instructions from the maintainers.
 
 ![](https://github.com/hahwul/noir/assets/13212227/23989dab-6b4d-4f18-904f-7f5cfd172b04)
 
-## 🛠️ How to Build and Test?
+## 🛠️ Building and Testing
 ### Clone and Install Dependencies
+
 ```bash
 # If you've forked this repository, clone to https://github.com/<YOU>/noir
 git clone https://github.com/hahwul/noir
@@ -38,13 +49,14 @@ ameba --fix
 ```
 
 ## 🧭 Code structure
-- spec (for `crystal spec`)
-  - unit_test: unit-test codes
-  - functional_test: functional test codes
-- src
-  - analyzer: Code analyzers for Endpoint URL and Parameter analysis
-  - detector: Codes for language, framework identification 
-  - models: Everything for the model, such as class, structure, etc
-  - utils: Utility codes
-  - etc...
-- noir.cr: main and command-line parser
+
+- spec: 
+  - unit_test: Unit test codes. (for `crystal spec` command)
+  - functional_test: Functional test codes.
+- src: Contains the source code.
+  - analyzer: Code analyzers for Endpoint URL and Parameter analysis.
+  - detector: Codes for language and framework identification.
+  - models: Contains everything related to models, such as classes and structures.
+- noir.cr: Main file and command-line parser.
+
+Feel free to reach out to us if you have any questions or need further assistance!