Skip to content

Latest commit

 

History

History
81 lines (53 loc) · 3.53 KB

CONTRIBUTING.md

File metadata and controls

81 lines (53 loc) · 3.53 KB
Raw

Contribute to validate-me

The following rules will make easier to review PR's. Please, follow them so we all can have a better developer experience.

Thank you!

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally
  • Follow https://conventionalcommits.org/. Is not mandatory for everyone except those who can merge to master.

CI Configuration

Skip CI

When is not necessary to execute the CI in a commit it needs be added [ci skip] to the commit description or title.

Installation

This project uses Yarn and lerna to manage this repo and each of the packages. It's mandatory to use Yarn instead of NPM, since we are using Yarn's workspaces to manage this monorepo.

Minimum requirements

  • NodeJS 8 or superior.
  • Yarn latest stable.

How to create a new Pull Request (PR)

  1. Fork the repo: https://help.github.com/articles/fork-a-repo/
  2. Clone your new forked repo in your computer.
  3. git checkout -b new_branch_name. Replace new_branch_name with the name you like.
  4. Make your changes.
  5. Commit your changes.
  6. Push your changes (the first time, git will ask you if you want to create the new branch remotely).
  7. Create the PR: https://help.github.com/articles/creating-a-pull-request-from-a-fork/

Things to take into account:

  • PR's don't have to be merged by themself. The user with merge permissions will do it once the PR is approved.

  • Don't use your master branch (from your fork). Instead: Develop your PR in there. Why?

    You do not want to issue pull requests from your fork’s master branch on Github.com to the parent repisitory because any new changes you add to the master branch will automatically show up in the pull request. That means changes you did not intend to be there, would now be there.

    https://blog.jasonmeridth.com/posts/do-not-issue-pull-requests-from-your-master-branch/

Common lerna commands

Add, update or remove a dependency from a package

yarn run lerna add {dependency-name} [--dev] --scope={@validate-me/package-name}

How to publish

For contribuitors with publish permissions, follow this steps:

  1. [One time only] Login permanently into NPM with this command: npm login.
  2. yarn lerna publish [--npm-tag=next].

NOTE: Use --npm-tag=next only for alpha/beta releases. Without the tag uses latest.

If, for some reason, lerna fails, but the commit was made, do the following:

  1. Report the bug and copy the lerna-debug.log file.
  2. Try to publish with the command that lerna tried to do (it will be written in the lerna-debug.log file). If for some reason that fails too:
    1. Add the console log to the issue.
    2. Revert the commits made by lerna.

How to generate changelog

To be able to use the yarn run changelog command, you'll need to set GITHUB_AUTH env variable with a GitHub API personal access token configured with the repo scope for private repositories or just public_repo scope for public repositories. Follow this steps:

  1. Access to https://github.com/settings/tokens.
  2. Generate a new token with the repo scope for private repositories or just public_repo scope for public repositories.
  3. Copy the new token.
  4. Create an .env file in the root folder of this project.
  5. Add the GITHUB_AUTH variable with the value of the token.