Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 1.83 KB

contributing.md

File metadata and controls

40 lines (28 loc) · 1.83 KB

🚀 Contributing to Pragmate UI

Thank you for your interest in contributing to Pragmate-UI! Your contributions are valuable in improving our codebase and making it even more robust. Below are the guidelines for contributing effectively.

General Guidelines

  • Use TypeScript and ESM (ECMAScript Modules) in any code you generate.
  • When importing React, use the following syntax: import * as React from 'react'.
  • For on-demand loading, we utilize the Pragmate library. Make sure to follow best practices when working with it.

Code Structure

  • Create components and objects in separate files.
  • Organize your files following logical and scalable patterns.
  • Use descriptive names for files, folders, and components.

Coding and Style Standards

  • Follow the coding and style standards defined in the linter configuration file.
  • Utilize the following CSS variables for visual consistency: [--text-color, --altern-text-color, ...]. These variables should align with the overall project design.

Contribution Process

  1. Fork this repository into your own GitHub account.
  2. Clone your fork to your local machine: git clone https://github.com/balearesg/pragmate-ui.git.
  3. Create a new branch for your contribution: git checkout -b my-branch-name.
  4. Make your changes and commits on the new branch.
  5. Ensure your changes adhere to the coding and style standards.
  6. Conduct thorough testing in your own environment.
  7. Push your branch to your fork on GitHub: git push origin my-branch-name.
  8. Create a pull request detailing your changes and the tests you've performed.

Community and Support

If you have any questions or need guidance, feel free to reach out to us on our usual communication platforms. We appreciate your commitment and look forward to your contributions.

Thank you for being a part of Pragmate-UI!