Contribution Guidelines

How to Contribute

We welcome contributions from developers of all skill levels! Whether you're fixing a bug, adding a new feature, or creating a new project, your contributions help make Plex better.

To get started, fork the repository, create a new branch for your changes, and submit a pull request. Make sure to follow our project structure and coding standards.

Project Structure

Each project should be placed in its own folder within the projects/ directory. The structure should follow this pattern:

projects/
  your-project-name/
    index.html
    icon.png (optional)
    README.md (optional)
    ...other files

Submission Guidelines

• Ensure your project is fully functional and tested
• Include a clear description of what your project does
• Add appropriate tags/categories for your project
• Make sure all files are properly organized
• Include an icon or screenshot if possible
• Write clean, readable, and well-commented code

Code Standards

We follow these coding standards to maintain consistency:

• Use semantic HTML5 elements
• Follow modern CSS best practices (consider using Tailwind CSS if appropriate)
• Write clean, readable JavaScript with proper error handling
• Comment complex logic and functions
• Ensure your code is responsive and works on multiple devices
• Test your project in multiple browsers

Pull Request Process

1. Fork the repository and clone it to your local machine
2. Create a new branch: git checkout -b feature/your-project-name
3. Add your project to the projects/ directory
4. Update the script.js file to include your project in the projects array
5. Commit your changes: git commit -m "Add: Your project name"
6. Push to your fork: git push origin feature/your-project-name
7. Open a Pull Request with a clear description of your project

Questions?

If you have any questions or need help, feel free to open an issue on GitHub or reach out to the maintainers. We're here to help!