๐ค Contributing & Development
Contributions to UIElement are welcome! This page provides guidelines for setting up your development environment, contributing code, and reporting issues to ensure a smooth collaboration process.
1. Code of Conduct
Please read and follow our Code of Conduct to foster an inclusive and respectful community.
2. How to Contribute
- Reporting Issues: If you encounter bugs or have feature requests, please open an issue in the GitHub Issues section.
- Submitting Pull Requests: To contribute code or documentation, fork the repository, create a new branch, and submit a pull request. See the Contributing Guidelines for more details.
- Proposing Enhancements: For feature proposals or enhancements, it's a good idea to first open an issue to discuss your idea before starting to code.
3. Setting Up the Development Environment
-
Clone the Repository: Clone the UIElement repository from GitHub:
git clone https://github.com/efflore/ui-element.git -
Install Dependencies: Navigate to the project directory and install the necessary dependencies using npm:
cd ui-element npm install -
Run the Development Server: Start the development server to work on the code and see live updates:
This will run the build process and serve the project locally.npm start
4. Testing and Building
-
Linting: Run linting to maintain code quality and formatting:
npm run lint -
Unit Testing: Execute the test suite to ensure everything works correctly:
npm test -
Building for Production: When you're ready to build the project for production, run:
The production build will be created in the `dist` directory.npm run build
5. Commit Message Guidelines
Use conventional commit messages for consistency and clarity. Examples include:
feat: add new feature to the component
fix: resolve issue with context updates
docs: update documentation for new API
chore: update build process and tooling
Refer to the Conventional Commits specification for more details.
6. Project Structure
Familiarize yourself with the project's folder structure:
- src/: Source code for UIElement components and utilities.
- docs/: Documentation files and assets for the GitHub Pages site.
- tests/: Unit and integration tests for UIElement.
- dist/: Compiled and minified production build output.
7. Resources
For more information and resources: