Skip to content

Contribution.md

Latest commit

 

History

History
44 lines (27 loc) · 2.71 KB

Contribution.md

File metadata and controls

44 lines (27 loc) · 2.71 KB

Contribution Guidelines for utils.js Design System

Thank you for considering contributing to the utils.js Design System. Your participation is vital to enhancing and refining our design framework. Whether you're an experienced developer, designer, or enthusiast, there are several ways you can contribute meaningfully.

Ways to Contribute

1. Code Contributions

Developers can contribute to the utils.js Design System by submitting code improvements, bug fixes, or new features. Follow these steps to start contributing:

  • Fork the Repository: Make a copy of the utils.js Design System repository to your GitHub account.
  • Clone the Repository: Download the repository to your local development environment.
  • Create a Branch: Set up a separate branch for your contribution to keep things organized.
  • Implement Changes: Make your modifications or additions in line with our design system principles.
  • Commit Guidelines: Follow our commit message format, starting with [type of changes] {r.f - ADD/UPDATE/FEAT/FIX}, followed by a brief message. Each message should be at least 14 characters long and end with a period.
  • Issue Creation: Before you start working, create an issue to discuss your proposed contribution. If there's already a relevant issue, join the discussion or indicate your intention to address it.
  • Pull Request Submission: Once your changes are ready and tested, submit a pull request to merge your branch into the Development Branch.
  • Test Validation: Ensure thorough testing to confirm that your changes integrate well with existing functionalities and don't introduce any issues.

2. Issue Reporting

If you encounter bugs or have suggestions for improvements, please open an issue and provide detailed information.

3. Documentation Refinement

Help us improve our documentation by fixing errors, improving clarity, and adding examples. Follow the same structured approach as code contributions.

4. Advocacy and Outreach

Spread the word about the utils.js Design System by writing blog posts, creating instructional materials, or promoting it in your professional networks. Your efforts will help expand our community and encourage more people to use the design system.

Code of Conduct

All contributors must adhere to our Code of Conduct. By participating, you agree to maintain a respectful and inclusive environment.

Get Started

Ready to contribute? Here's how you can get started:

  1. Fork utils.js Design System on GitHub
  2. Explore Open Issues
  3. Submit a Pull Request to the Development Branch

We welcome you to the utils.js Design System community and appreciate your support and contributions.