Merge pull request #21 from TheCodeRaccoons/Documentation-and-project-setup

Documentation and project setup

Author: JorchCortez

.github/PULL_REQUEST_TEMPLATE/NEW_FEATURE.md

@@ -2,11 +2,11 @@
 
 <!-- Tick the checkboxes to ensure you've done everything correctly -->
 - [ ] PR does not match another non-stale PR currently opened
-- [ ] PR name matches the format *[ feature ]: <i>Feature Name</i> (<i>versions separated by comma</i>)*. More details [here](https://github.com/TheCodeRaccoons/WebflowTrickery/wiki/Overview-on-Submitting-Features)
+- [ ] PR name matches the format *[ feature ]: <i>Feature Name</i> (<i>versions separated by comma</i>)*. More details [here](https://github.com/TheCodeRaccoons/WebTricks/wiki/Overview-on-Submitting-Features)
 - [ ] PR's base is the `develop` branch.
-- [ ] Your Feature matches the standards laid out [here](https://github.com/TheCodeRaccoons/WebflowTrickery/wiki/Programming-Standards)
+- [ ] Your Feature matches the standards laid out [here](https://github.com/TheCodeRaccoons/WebTricks/wiki/Programming-Standards)
 
-<!-- Refer to the [contributing](https://github.com/TheCodeRaccoons/WebflowTrickery/wiki/Contributing) guidelines for more details. -->
+<!-- Refer to the [contributing](https://github.com/TheCodeRaccoons/WebTricks/wiki/Contributing) guidelines for more details. -->
 
 ## Features
 <!-- List your features here and the benefits they bring. Include images/codes if appropriate -->

CONTRIBUTING.md

@@ -0,0 +1,83 @@
+# Contributing to Webtricks
+
+Thank you for considering contributing to **Webtricks**! By contributing, you help make this project more robust, efficient, and accessible to developers worldwide. Please follow these guidelines to ensure a smooth and effective collaboration.
+
+---
+
+## How to Contribute
+
+### Reporting Issues
+If you encounter bugs, have feature requests, or need clarification, please:
+1. Check the [issues page](https://github.com/TheCodeRaccoons/WebTricks/issues) to see if the issue has already been reported.
+2. Open a new issue if necessary:
+   - Provide a clear and descriptive title.
+   - Include steps to reproduce the issue (if applicable).
+   - Attach screenshots, code snippets, or relevant files to help us understand the problem.
+
+### Suggesting Features
+Have a cool idea to improve **Webtricks**? Open an issue and tag it as a `feature request`. Please include:
+- A brief explanation of your idea.
+- Why it would be useful for other developers.
+- If possible, examples of similar features or inspiration.
+
+---
+
+## Code Contributions
+
+### Getting Started
+1. **Fork the Repository**:
+   - Go to [Webtricks GitHub Repository](https://github.com/TheCodeRaccoons/WebTricks).
+   - Click `Fork` to create your copy of the repository.
+
+2. **Clone Your Fork**:
+   ```bash
+   git clone https://github.com/your-username/webtricks.git
+   cd webtricks
+   ```
+   
+3. **Create a Branch:**
+    ```bash
+    git checkout -b feature/your-feature-name
+    ```
+    or
+    ```bash
+    git checkout -b fix/your-fix-name
+    ```
+4. **Make Your Changes:**
+  - Follow the coding style and structure already established.
+  - Test your changes locally before committing.
+
+6. **Commit Your Changes:**
+    ```bash
+    git add .
+    git commit -m "Description of your changes"
+    ```
+
+7. **Push to Your Fork:**
+    ```bash
+    git push origin feature/your-feature-name
+    ```
+
+8. **Create a Pull Request:**
+  - Go to your fork on GitHub and click Compare & pull request.
+  - Provide a clear description of your changes and link any related issues.
+  - Provide a working example if it is a new feature or a codepen link / webflow.io link of the functionality working properly
+
+---
+
+## Development Guidelines
+Code Standards
+  - Use vanilla JavaScript and avoid adding external dependencies.
+  - Follow consistent naming conventions for attributes and variables.
+  - Ensure clear and concise documentation for new features.
+
+Testing
+  - Test your changes thoroughly before submitting.
+  - Add examples in the examples/ folder for any new functionality.
+---
+## Join the Discussion
+Participate in ongoing discussions in [GitHub Discussions](https://github.com/TheCodeRaccoons/WebTricks/discussions).
+Share your feedback, ideas, and improvements.
+
+
+Thank you for helping make Webtricks better!