Skip to content

Latest commit

 

History

History
90 lines (65 loc) · 3 KB

CONTRIBUTING.md

File metadata and controls

90 lines (65 loc) · 3 KB

Contributing

Feature requests

When you have an idea on how we could improve, please check our issues to see if there are similar ideas. If there are none, please submit your feature request as an issue. Add a clear description of what you expect from the improvement and what the use case is. The issue will be tagged as new and included in the backlog when the issue is ready to be developed will be moved to To Do and any developer could take it and solve it. If you want to solve any issue, assing it to you and make a PR whe it is ready.

Existing components: we love pull requests ♥

Help out the whole Aplana la curva community by sending your merge requests and issues. Check out how to set it up:

Setup:

# Clone the repo:
git clone https://github.com/aplanalacurva/aplanalacurva-components.git
cd aplanalacurva-components

# Install dependencies
# We require yarn as we use yarn workspaces
yarn install

# Create a branch for your changes
git checkout -b fix/buttonSize

Make sure everything works as expected:

# Format
npm run format

# Linting
npm run lint

# Tests
npm run test

# Storybook Demo
npm run storybook

Create a Pull Request:

Some things that will increase the chance that your merge request is accepted:

How to create a new component

Steps to create a new component alc-[component] where [component] is the name of your component with slashes if it has more than 1 word:

$ cd components
$ npm init @open-wc
  ✔ What would you like to do today? › Scaffold a new project
  ✔ What would you like to scaffold? › Web Component
  ✔ What would you like to add? › Testing
  ✔ Would you like to scaffold examples files for? › Testing
  ✔ What is the tag name of your application/web component? … [alc-component]
  ✔ Do you want to write this file structure to disk? › Yes
  ✔ Do you want to install dependencies? › No
$ mv [alc-component] [component]
$ cd [alc-component]
$ rm karma.*
$ rm .editorconfig
$ rm .gitignore
$ mv index.js src/
$ mv [alc-component].js src/

Finally, we have to do some changes in pakage.json:

  • "name": "@aplanalacurva/[component]"
  • "scripts" --> copy from _config/pakage-scripts.json
  • "main": "src/index.js"
  • "module": "src/index.js"