Skip to content

Latest commit

 

History

History
89 lines (58 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

89 lines (58 loc) · 2.71 KB
Raw

Thanks for showing interest to contribute to FE-Theme...!

Setup the Project

Setup fe-theme locally on your machine and use in the your project

Development

To improve our development process, we've set up tooling and systems. FE-Theme uses a monorepo structure and we treat each component as an independent package that can be consumed in isolation.

Tooling

  • PNPM to manage packages and dependencies

Commands

pnpm install: bootstraps the entire project, symlinks all dependencies for cross-component development and builds all components.

Think you found a bug?

Please conform to the issue template and provide a clear path to reproduction with a code example. The best way to show a bug is by sending a CodeSandbox link.

You may wish to use our starters to help you get going:

Proposing new or changed API?

Please provide thoughtful comments and some sample API code. Proposals that don't line up with our roadmap or don't have a thoughtful explanation will be closed.

Making a Pull Request?

Pull requests need only the 👍 of two or more collaborators to be merged; when the PR author is a collaborator, that counts as one.

Commit Convention

Before you create a Pull Request, please check whether your commits comply with the commit conventions used in this repository.

When you create a commit we kindly ask you to follow the convention category(scope or module): message in your commit message while using one of the following categories:

  • feat / feature: all changes that introduce completely new code or new features
  • fix: changes that fix a bug (ideally you will additionally reference an issue if present)
  • refactor: any code related change that is not a fix nor a feature
  • docs: changing existing or creating new documentation (i.e. README, docs for usage of a lib or cli usage)
  • build: all changes regarding the build of the software, changes to dependencies or the addition of new dependencies
  • test: all changes regarding tests (adding new tests or changing existing ones)
  • ci: all changes regarding the configuration of continuous integration (i.e. github actions, ci system)
  • chore: all changes to the repository that do not fit into any of the above categories

Steps to PR

Under Maintenance

Tests

All commits that fix bugs or add features need a test.

Want to write a blog post or tutorial

Under Maintenance

Want to help improve the docs?

Under Maintenance

License

By contributing your code to the fe-theme GitHub repository, you agree to license your contribution under the MIT license.