Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
94 lines (71 loc) · 3.13 KB

CONTRIBUTING.md

File metadata and controls

94 lines (71 loc) · 3.13 KB
Raw

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 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:

  2. Clone Your Fork:

    git clone https://github.com/your-username/webtricks.git
cd webtricks

  3. Create a Branch:

    git checkout -b feature/your-feature-name

    or

    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.

  1. Commit Your Changes:

    git add .
git commit -m "Description of your changes"

  2. Push to Your Fork:

    git push origin feature/your-feature-name

  3. 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.

Contributors

This project is made possible by:

The contributor list (avatars + profile links) in README.md is updated automatically after merges to main via a GitHub Action. To appear there:

  1. Make at least one merged commit to the main branch (directly or via PR merge).
  2. Ensure your GitHub profile has a public avatar (default works fine).

Inactive or bot accounts may be filtered out automatically.

Join the Discussion

Participate in ongoing discussions in GitHub Discussions. Share your feedback, ideas, and improvements.

Thank you for helping make Webtricks better!