Skip to content

Latest commit

 

History

History
469 lines (341 loc) · 31.5 KB

CONTRIBUTING.md

File metadata and controls

469 lines (341 loc) · 31.5 KB
Raw

Contributing to Clay

Want to contribute to Clay? There are a few things you need to know before you start sending your pull requests or opening issues.

Here's a set of guidelines to contribute to Clay and its packages. Use your common sense, and feel free to propose changes to this document in a pull request.

For contributions to Clay v2, go to branch 2.x and follow the contribution guide.

Table of Contents

What Should I Know Before I Get Started?

Clay and Packages

The Clay repository follows the monorepo approach; the pillars of Clay, all the major components, are in this one repository.

  • clay-css - Provides the colors and structure for Clay. It contains the CSS and example HTML markup for each component.
  • clay-components - The components that follow clay-css markup and Lexicon use cases. They are developed on React.js in version 3.x.
  • clayui.com - Contains the source code and documentation for clayui.com.

How Can I Contribute?

Reporting Bugs

This section shows you how to submit an error report to Clay. Follow these guidelines so maintainers can clearly understand your report, reproduce the behavior, and find related reports.

Before Submitting a Bug Report

  • Check existing issues to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.

How Do I Submit a Good Bug Report?

Bugs are tracked as Github issues. Create an issue, and provide the information listed below so the maintainers can reproduce the problem:

  • Use a clear and descriptive title for the issue that identifies the problem.
  • Describe the exact steps to reproduce the problem in as much detail as possible.
  • Describe the behavior you observed after following the steps, and explain the problem with that behavior.
  • Explain the desired behavior you expected and why.
  • Include screenshots and animated GIFs if necessary.
  • If the problem is related to performance or memory, include a CPU profile capture with your report.
  • If the problem only occurs in a specific browser, specify the name and version of the browser.

Provide more context by answering this question:

  • Can you reliably reproduce the issue? If not, provide details about how frequently the problem occurs and under which conditions it normally happens.

Your First Pull Request

If you want to contribute to this project but you don't know where to begin, issues with the "good first issue" label are a great place to start.

If you decide to fix an issue, please check the comment thread first to make sure that no one else is working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don’t duplicate your effort.

Proposing a Change

This section shows you how to propose a public API change, make non-trivial changes to the implementation, or propose something new. Follow these guidelines so maintainers can clearly understand your suggestion and your point of view.

Before Submitting a Suggestion for Improvement

  • Check existing suggestions to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.

How Do I Submit a Suggestion for Improvement?

Suggestions for enhancement or API changes are tracked as Github issues. Create an issue in this repository and provide the following information:

  • Use a clear and descriptive title for the issue that states your suggestion.
  • Provide a step-by-step description of the suggested enhancement in as much detail as possible.
  • Describe the current behavior, and explain the behavior you want to see instead and why.
  • Provide details of the impact your change will make and how you will use it.
  • Provide the pros and cons of your change.
  • Provide at least one alternative for your change.

Sending a Pull Request

This section shows you how to send a pull request. The main staff are always monitoring pull requests, so rest assured that they will review yours. Follow these guidelines so the maintainers can complete a thorough review of your request.

Be sure to check the accessibility tab of the Storybook to ensure accessibility tests are going pass.

Before Sending a Pull Request

  • Fork the repository and create your branch from master.
  • Run yarn at the root of the repository to install the project dependencies.
  • Run yarn lerna to install the dependencies of each package and link them together.
  • Run yarn build to build all packages.
  • If you’ve fixed a bug or added code that should be tested, add tests!
  • Run yarn test to ensure the test suite passes.
  • Run yarn format to format your code with Prettier.
  • Run yarn lint to make sure your code lints.

Style Guides

Git Commit Messages

This section shows you how to write commit messages in Clay. Follow these guidelines to help us maintain order and make it easier to locate your changes.

Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope, a jira ticket number and a subject:

<type>(<scope>): <jira ticket number> <subject>

The header is mandatory and the scope of the header is optional.

Clay follows the "Conventional Commits" specification.

Type

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation-only changes
  • refactor: A code change that neither fixes a bug nor adds a feature
  • chore: Changes in the build process, auxiliary tools, libraries, tests or formatting

Scope

The scope could be anything specifying place of the commit change. For example feat(@clayui/dropdown), feat(@clayui/css), fix(clayui.com), docs(Badge), fix(useCache), etc...

Jira Ticket Number

At present, we are exclusively utilizing LPD tickets for management. Link for How To Open a LPD Ticket to Clay

JavaScript Style Guide

All JavaScript must adhere to the Liferay JavaScript style guide.

CSS Guidelines

See guidelines for contribution with CSS.

Documentation Style Guide

Clay uses TypeScript, obviating the need to write explicit JSDOC annotations for parameter and return types. We still write descriptions, however, for interface, type, enum etc to make it easier to use components.

interface IProps {
	/**
	 * Default position of menu element. Values come from `metal-position`.
	 */
	alignmentPosition?: number;
}

Additional Notes

Issue Labels

This section lists the labels we use to help us organize and track the issues.

Labels are organized by categories, such as the component the problem affects, the resolution, the status...

You may want to use Github search to find groups of issues you are interested in. For example, you may be interested in open bug issues in Clay components. Use this to create more focused queries.

Categorization

Category Description
Component Specifies the component the problem affects (e.g Clay Components, Charts...)
Type Specifies the type of issue (e.g Bug...)
Status Group of labels that reflect the progress of the issue
Resolution Group of labels reflecting the resolution of the issue
Browser Identifies the specific browser the issue affects, if applicable

Labels

Label liferay/clay Category Description
RFC search None A proposal for changes or a request for new features (similar to the RFCs that are used in React.js, Ember.js, Gatsby.js, and Rust)
Infrastructure search Component Monorepo infrastructure, build, process automation...
Clay Components search Component Clay components (e.g ClayCard, ClayLabel...)
Clay Charts search Component Components of Charts
Generator Clay search Component Our Clay Component Generator
Clay CSS search Component Clay CSS
Documentation search Component Documentation in general, in clayui.com or elsewhere...
Accessibility search Component Accessibility issues
Clay site search Component Website infrastructure or other things outside documentation that relate to the site
IE search Browser Occurs exclusively in IE browser
Chrome search Browser Occurs exclusively in Chrome browser
Safari search Browser Occurs exclusively in Safari browser
Firefox search Browser Occurs exclusively in Firefox browser
Breaking Change search Type Caused a breaking change in API or a change in behavior
Bug search Type Problems with Component behavior
Epic search Type Opened as an Epic (a collection of many related things to be done)
Discussion search Type A discussion of some change or a request for information
Enhancement search Type A suggestion for improvements or refinement of code
Feature Request search Type A suggestion for new features
Regression search Type Regressions
Blocked search Status Blocked by other tasks
Help Wanted search Status Requires help
Next Release search Status Will be available in the next release
Duplicate search Resolution Duplicates an existing issue
Wontfix search Resolution Will no longer be worked on

Release process

The Clay release process is done every week, initially every Monday we are cutting a new version. The release is done in two steps, cutting a new version and publishing to NPM, and updating the packages in liferay-portal.

Making a new release, it is recommended to follow the automated step instead of following the manual step.

Automated release

The automated release is done through Github Actions, the action must be manually triggered to run the tests, visual tests with chromatic, cut the version and publish the packages.

  1. Go to link https://github.com/liferay/clay/actions/workflows/release.yml
  2. Run the workflow

Sets the encoded version via input is optional. Just define if necessary.

When all tests pass, create a release note in the Github interface of the generated version containing the changelog that is automatically generated in CHANGELOG.md.

Manual release

To publish a new version for all packages that have updated, follow these steps:

# Checkout latest
git checkout master

# Install dependencies and build css package
yarn
yarn workspace @clayui/css run build

# Make sure you have all of the tags from upstream.
git fetch $REMOTE --tags

# This updates each packages versions and makes proper version bumps
# based on its dependencies. The `--conventional-commits` flag should
# automatically determine what version each package should be updated to
lerna version --conventional-commits --no-push

# WARNING: If you see that the previous commands suggests an
# incorect version, for example a major version change, you
# should use this command instead:
# lerna version --no-push
# and set the version manually.

# Optionally, you might want to run `yarn checkDeps` to make sure the
# dependencies are in sync. Before you do that, you'll also want to
# remove any "old" build files, which can be done with
# find packages -mindepth 2 -maxdepth 2 -name lib -type d | xargs rm -rf {}
# yarn checkDeps

# Create draft pull-request against `stable` (not intended to be merged)
# to the clay repo; this is to see CI green one last time.
# (Example below uses node-gh CLI tool)
gh pr --submit liferay --branch stable --draft

# Once CI is green, close the pull-request and merge changes to stable and master.
# If you want to see a preview first, use the `--dry-run` flag.
# (This assumes you are on the `master` branch)
git push $REMOTE master --follow-tags
git push $REMOTE master:stable

# Publish packages to NPM
yarn build && yarn buildTypes
lerna publish from-package

# Note: If this last step breaks, you may try running `lerna publish from-git` instead.

NOTE: Publishing new packages automatically with Lerna is sometimes a problem, if you have problems try to publish the package separately manually.

Releasing individual packages

In a rare case you may want to release only one specific package. Follow these steps:

Note: this is pretty rare to only release a single package, make sure you are only doing this as a last resort. Typically you should be able to just release everything at once.

# Checkout latest
git checkout master

# Navigate to specific package
cd ./packages/$COMPONENT_DIR

# Look at the git history of the package and determine if it relies on any
# non-released code from other packages.
#
# If it relies on other packages, you must publish those dependencies first following
# these same steps (start at step 1 with the dependent package).
#
# After you have published any dependencies needed

# Update Version.
# Any feat commits since last release require a minor version.
# If only chore or fix commits, a patch is required.
yarn version

# Create draft pull-request against `stable` (not intended to be merged)
# to the clay repo; this is to see CI green one last time.
# (Example below uses node-gh CLI tool)
gh pr --submit liferay --branch stable --draft

# Once CI is green, close the pull-request and merge changes to stable and master.
# If you want to see a preview first, use the `--dry-run` flag.
git push $REMOTE master --follow-tags

# Build.
yarn build && yarn buildTypes

# Publish to NPM.
# Make sure you are in the directory of the package you want to publish.
yarn publish

# Congratulations! You should see successfully published packages.
#
# You may also need to do some post-publish administration and close
# the current Milestone in the Github interface,
#
# Closing the milestone will trigger a Github action to comment on each closed
# issue in the milestone, notifying that the issue is fixed and publicly
# available in the latest release.

Common Issues

Updating release in liferay-portal

# Navigate
cd {PORTAL_ROOT}/modules/apps/frontend-taglib/frontend-taglib-clay

# Update clay dependencies in `package.json`
# Typically is easiest to use a package like
# https://www.npmjs.com/package/npm-check-updates
#
# Note that sometimes there is a delay between publishing a package
# and it being seen on the registry. Make sure to verify all versions
# have been properly updated in the package.json.
ncu '/@clayui/' -u

# If you don't want to install `npm-check-updates` as a global package,
# you can also use this command
# npx npm-check-updates '/@clayui/' -u

# Run source formatter
#
# Often this will also update other files other than `package.json`
# files and the `yarn.lock`. Disregard changes to files other than those.
cd {PORTAL_ROOT}/portal-impl
ant format-source-all

# Update an dedup yarn.lock
cd {PORTAL_ROOT}/modules
yarn
npx yarn-deduplicate yarn.lock

# Verify yarn.lock stats
#
# If diff numbers are considerably off (more + then - or viceversa),
# review the contents to find an explanation
git diff --stat yarn.lock

# Update taglib markup if necessary
#
# Take a look at the markup changes in this new version of clay and make the
# corresponding changes to our serverside markup in `frontend-taglib-clay`.

# Run unit tests locally
# you may need to update snapshots for various modules
cd {PORTAL_ROOT}/modules
../gradlew packageRunTest

Once all tests have ✅ passed, send a pull request!

  1. Send pull request to https://github.com/liferay-platform-experience/liferay-portal
  2. Copy the generated changelog and use that in your pull request description.
    • The PR title and commit message can be: "LPD-XXXXXX Update packages @clayui/* to v{CLAY_VERSION}"
  3. Link your pull request to the LPD ticket in the current Jira Epic.
    • To find this, the LPD is typically called "Update Clay Dependencies".
  4. Run E2E testing.
    • ci:test:relevant
    • ci:test:clay
      • If relevant is not passed, it is good to check that the important tests are passing. It may happen that we have flaky tests now that poshi tests are not being given much priority and we no longer have QA checking.

Lastly, share the release information in our public Slack channel!

  1. Create a thread in the channel #t-dxp-platform-experience
    • The title usually has a pattern [:clay: Clay Release {MONTH DAY} - In progress]
  2. Add a message to the thread placing the links:
    • Link to the LPD ticket that is related to updating Clay packages on liferay-portal.
    • Link to epic ticket
    • Link to the release note that was created manually using the Github interface

Testing local changes in liferay-portal

When working on an issue, you might want to test your changes before submitting a pull request.

To test your changes in a liferay-portal (>= 7.3.x) environment you'll first need to install the verdaccio npm package. Warning Please note that we don't maintain this tool and won't provide support for it. For usage instructions, doubts or any issues that you have, please consult the project's page on GitHub.

# First install the verdaccio package globally
npm i -g verdaccio

# Alternatively, if you are using yarn, you can issue this command
# yarn global add verdaccio

# Once installed, you'll need to leave verdaccio running locally
# If everything is correct, it will use http://localhost:4873 by default
verdaccio

# In order to publish packages, you'll need to open a new terminal window
# and create a user and log in
npm adduser --registry http://localhost:4873

# Let's assume you have made some changes in the clay-button component,
# in order to test those changes, you'll need to publish the package locally.

# IMPORTANT:
# Publishing an "existing version" of a module will fail;
# in order to fix that, you'll need to change the "version" field in the
# package.json file of the module you want to publish.
# Once you are sure that the version you are going to publish is not
# already published on npmjs.com, you can publish the package locally

cd packages/clay-button
npm publish --registry http://localhost:4873

# If you are using yarn, you can issue this command instead
# YARN_REGISTRY=http://localhost:4873 yarn publish

# Now navigate to the frontend-taglib-clay module of your Liferay Portal
cd {PORTAL_ROOT}/modules/apps/frontend-taglib/frontend-taglib-clay

# Install the @clayui/button package from your local registry
YARN_REGISTRY=http://localhost:4873 yarn add @clayui/button

# Before deploying, you shoud stop the tomcat that's running your Liferay Portal

# Deploy the module
gradlew deploy -a

# Restart the tomcat