Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (44 loc) · 2.53 KB

CONTRIBUTING.md

File metadata and controls

57 lines (44 loc) · 2.53 KB
Raw

Contributing to CDS Tawk.to Customizer

Thank you for your interest in contributing to CDS Tawk.to Customizer! We welcome contributions from the community to help improve this project.

By contributing to this project, you agree that your contributions will be licensed under the project's Creative Commons Attribution-NonCommercial 4.0 International Public License.

🛠 How to Contribute

⚠️ Important: All code contributions must be submitted via Pull Requests (PRs). Direct commits to the main branch are not allowed.

1. Reporting Bugs

If you find a bug, please create a new issue on GitHub describing:

  • What you expected to happen.
  • What actually happened.
  • Steps to reproduce the issue.
  • Browser and OS version.

2. Suggesting Enhancements

We love hearing about new ideas! If you have a suggestion:

  • Check if the feature is already requested in existing issues.
  • Open a new issue describing the feature and why it would be useful.

3. Pull Requests (PRs)

  1. Fork the repository to your own GitHub account.
  2. Clone the project to your local machine.
  3. Create a new branch for your feature or fix: 
    git checkout -b feature/amazing-feature
  4. Make your changes. Please keep the code clean and commented where necessary.
  5. Test your changes. Since this is a vanilla JavaScript project, ensure it works by testing it in a local HTML file with a Tawk.to widget embedded.
  6. Commit your changes: 
    git commit -m "Add some amazing feature"
  7. Push to the branch: 
    git push origin feature/amazing-feature
  8. Open a Pull Request. Describe what you changed and link to any relevant issues.

💻 Development Guidelines

  • Code Style: Keep the code simple and readable. This project uses vanilla JavaScript (ES6+).
  • No Dependencies: Do not introduce external dependencies unless absolutely necessary and discussed in an issue first.
  • Performance: Ensure your changes do not negatively impact the loading time or performance of the host page.

📜 License Notice

Please note that this project is licensed under CC BY-NC 4.0. This means:

  • You retain copyright of your contributions.
  • By submitting a PR, you grant Calatayud Digital Solutions and the community the right to use your contribution under the terms of the CC BY-NC 4.0 license.
  • This ensures the project remains free for non-commercial use while protecting the commercial rights of the maintainers.

Thank you for helping make this project better! 🚀