Improve README, CONTRIBUTING.md, and PULL_REQUEST_TEMPLATE.md for Better User and Contributor Guidance

.github/PULL_REQUEST_TEMPLATE/documentation.md

@@ -17,6 +17,10 @@ release. Write RST between the following start and end comments.-->
 ## Checklist
 - [ ] I have read the [Contributing Guidelines](https://github.com/drageelr/manim-data-structures/blob/main/CONTRIBUTING.md)
 - [ ] I have written a descriptive PR title (see top of PR template for examples)
+- [ ]  Code changes are well-documented.
+- [ ]  Any new .rst files have been added to the documentation.
+- [ ]  All dependencies are listed in requirements.txt if necessary.
+- [ ]  All linting checks have been run and passed.
 
 <!-- Do not modify the lines below. These are for the reviewers of your PR -->
 ## Reviewer Checklist

CONTRIBUTING.md

@@ -31,6 +31,23 @@ git push origin dev
 ### Initiate a PR
 Once you have finalized your contribution, navigate to this [link](https://github.com/ufosc/manim-data-structures/pulls) to create a new pull request and submit it.
 
+## Contributing to Documentation
+We welcome contributions to improve the project's documentation. To contribute, follow these steps:
+
+Edit or add new .rst files in the docs directory as needed.
+   1. To preview your changes, generate the documentation using the following command:
+   2. make html
+   3. Review the generated HTML in _build/html/index.html to ensure the documentation is
+      formatted correctly.
+   4. Submit a pull request with a description of the changes made.
+
+## Coding Standards
+Please ensure that your code follows our style guidelines. We use flake8 for linting. To run linting checks, use:
+
+flake8 your-code-file.py
+
+All code contributions should pass the linting checks before submitting a pull request.
+
 ### Closing note
 Once your PR is approved, it will be merged into the `dev` branch and we are looking at eventually merging upstream.
 

README.md

@@ -37,6 +37,33 @@ The goal is to produce a [Manim Plugin](https://www.manim.community/en/stable/pl
 ## Contributing
 For information on how to contribute to this project, please see [CONTRIBUTING.md](CONTRIBUTING.md).
 
+## Installation Instructions
+To install the project and its dependencies, follow these steps:
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/your-repo-link.git
+2. Navigate to the project directory:
+    cd your-project-directory
+3. Install the required dependencies using pip:
+   pip install -r requirements.txt
+
+Once installed, you can run the project by executing the following command:
+python mlinearcollection.py
+
+For detailed usage examples, refer to the following sections in the documentation:
+-Arrays
+-Variables
+
+## Building the Documentation
+This project uses Sphinx for generating its documentation. To generate the HTML documentation locally, follow these steps:
+
+1. Navigate to the docs directory:
+   cd docs
+2. Build the documentation using the Makefile:
+   make html
+3. The documentation will be available at _build/html/index.html. Open it in a web browser to view the project documentation.
+
+
 ## Resources Links
 - [Getting Started](https://docs.manim.community/en/stable/installation.html)
 - [Official Manim Community Documentation](https://docs.manim.community/en/stable/)