core/client/uikit/CONTRIBUTING.md

Contributing to UIkit

You want to contribute to UIkit? Awesome. Please take a few moments to review the following guidelines to get you started. Cheers.

• Communication channels
• Team members
• Documentation
• Issue tracker
• Bug reports
• Pull requests
• Versioning
• License

Communication channels

Before you get lost in the repository, here are a few starting points for you to check out. You might find that others have had similar questions or that your question rather belongs in one place than another.

• Chat: https://discord.gg/NEt4Pv7
• Website: https://getuikit.com
• Twitter: https://twitter.com/getuikit

Team members

UIkit is developed as an open source project by YOOtheme in Hamburg, Germany. The core maintainers you will encounter in this project are all part of YOOtheme.

Documentation

The UIkit documentation is maintained as a collection of Markdown files in its own repository. Any pull requests are highly appreciated.

Using the issue tracker

The issue tracker is the preferred channel for bug reports, features requests and submitting pull requests, but please respect the following restriction:

Please do not use the issue tracker for personal support requests (use Discord chat).

Bug reports

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!

A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What would you expect to be the outcome? All these details will help people to fix any potential bugs.

Pull requests

Good pull requests - patches, improvements, new features - are a fantastic help. Thanks for taking the time to contribute.

Please ask first before embarking on any significant pull request, otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.

UIkit follows the GitFlow branching model. The master branch always reflects a production-ready state while the latest development is taking place in the develop branch.

Each time you want to work on a fix or a new feature, create a new branch based on the develop branch: git checkout -b BRANCH_NAME develop. Only pull requests to the develop branch will be merged.

Commit Message Convention

UIkit adapts the Vue's commit convention. Commit messages can have the following types:

• build: Changes that affect the build system or external dependencies
• chore: Changes to readme, etc
• ci: Changes to our CI configuration files and scripts
• docs: Documentation only changes
• feat: A new feature
• fix: A bug fix
• perf: A code change that improves performance
• refactor: A code change that neither fixes a bug nor adds a feature
• style: Changes that do not affect the meaning of the code (white-space, formatting, etc.)
• test: Adding missing tests or correcting existing tests

Versioning

UIkit is maintained by using the Semantic Versioning Specification (SemVer).

License

By contributing your code, you agree to license your contribution under the MIT license