Skip to content

Latest commit

 

History

History
115 lines (69 loc) · 4.42 KB

CONTRIBUTING.md

File metadata and controls

115 lines (69 loc) · 4.42 KB
Raw

Contributing to one-app-cli

✨ Thank you for taking the time to contribute to this project ✨

📖 Table of Contents

Code of Conduct

This project adheres to the American Express Code of Conduct. By contributing, you are expected to honor these guidelines.

Developing

Installation

  1. Fork the repository one-app-cli to your GitHub account.

  2. Afterwards run the following commands in your terminal Please review this tutorial to learn how to clone a repository https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository

    $ git clone https://github.com/<your-github-username>/one-app-cli
$ cd one-app-cli

    replace your-github-username with your github username

  3. Install the dependencies by running

    $ yarn

  4. You can now run the scripts within the different packages.

Creating a one-app-cli new release

  1. Create, checkout and push a new release branch
  2. Run yarn lerna:version locally from your release branch. This will push your release changes(changelog and tags) to the branch on github.
  3. Ensure that correctly formatted tags have been created for each package being versioned. Tag needs to be in the format of @americanexpress/[package-name]@x.x.x for example@americanexpress/one-app-bundler@6.0.0. This can impact future releases.
  4. Create a pull request from your branch to the main branch with your changes.
  5. When merging try to ensure that commit does not get squashed as this will cause the tags be against missing commits.
  6. Once merged run the manually publish github action workflow.

One App Cli is currently not setup for pre-releases. In theory, if one is required, using --conventional-prerelease in step two should work. For example: yarn lerna:version --conventional-prerelease

Submitting a new feature

When submitting a new feature request or enhancement of an existing features please review the following:

Is your feature request related to a problem

Please provide a clear and concise description of what you want and what your use case is.

Provide an example

Please include a snippets of the code of the new feature.

Describe the suggested enhancement

A clear and concise description of the enhancement to be added include a step-by-step guide if applicable. Add any other context or screenshots or animated GIFs about the feature request.

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Reporting bugs

All issues are submitted within GitHub issues. Please check this before submitting a new issue.

Describe the bug

A clear and concise description of what the bug is.

Provide step-by-step guide on how to reproduce the bug

Please provide code snippets or a link to a repository, with steps to reproduce the behavior, failure or topic of discussion.

Expected behavior

Please provide a description of the expected behavior

Screenshots

If applicable, add screenshots or animated GIFs to help explain your problem.

System information

Provide the system information which is not limited to the below:

  • OS: [e.g. macOS, Windows]
  • Browser (if applies) [e.g. chrome, safari]
  • Version of faux-cdn: [e.g. 5.0.0]
  • Node version:[e.g 10.15.1]

Security Bugs

Please review our Security Policy. Please follow the instructions outlined in the policy.

Getting in contact

Coding conventions

Git Commit Guidelines

We follow conventional commits for git commit message formatting. These rules make it easier to review commit logs and improve contextual understanding of code changes. This also allows us to auto-generate the CHANGELOG from commit messages.