Skip to content

Latest commit

 

History

History
53 lines (38 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

53 lines (38 loc) · 1.65 KB

Contributing to UIFactory

Welcome, and thanks for considering contributing to UIFactory.

You could:

  • Report issues. Have you identified a reproducible problem in UIFactory?
    • Check if it's already filed in open issues.
    • If it's filed, upvote it (👍).
    • If not, create a new issue. Please include the UIFactory version, the code, what you expected, and what happened.
  • Fix documentation. Is the documentation unclear or wrong? Please report an issue, or send a pull request correcting it.
  • Fix issues. If you'd like to fix an issue, please email [email protected].
  • Submit components. If you'd like to add a component to UIFactory, please email [email protected].

We have a code of conduct. Please follow it in your interactions with the project.

Coding style

This project follows the eslint:recommended rules, with

  • 2-space indentation
  • UNIX line endings
  • No semicolons
  • Single quotes, not double quotes

Releasing UIFactory

To release a new version:

  • Update package version in
  • Run npm update && npm upgrade
  • Run npm run build
  • Run npm run lint and fix any errors
  • Run npm test and fix any errors

Run:

git commit . -m"BLD: Release x.x.x"
git tag -m"" -a vx.x.x
git push --follow-tags
npm publish