Skip to content

Latest commit

 

History

History
345 lines (228 loc) · 15.9 KB

CONTRIBUTING.md

File metadata and controls

345 lines (228 loc) · 15.9 KB
Raw

Contributing to Amplify CLI

Thank you for your interest in contributing to our project! 💛

Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community. Please read through these guidelines carefully before submitting a PR or issue and let us know if it's not up-to-date (or even better, submit a PR with your proposed corrections 😉).

Getting Started

Our work is done directly on Github and PR's are sent to the github repo by core team members and contributors. Everyone undergoes the same review process to get their changes into the repo.

This section should get you running with Amplify CLI and get you familiar with the basics of the codebase.

Local Environment Setup

  1. Ensure you have Node.js 18 installed, which comes bundled with npm. Use it to install or upgrade yarn:

    npm install --global yarn

    Ensure that .bin directory is added to your PATH. For example, add export PATH="<amplify-cli/.bin>:$PATH" to your shell profile file on Linux or macOS.

  2. Ensure you have Java installed and java command is available in your system. This is required for DynamoDB emulator.

  3. Ensure you are using the npm registry, even with yarn by running yarn config set npmRegistryServer https://registry.npmjs.org

  4. Start by forking the dev branch of amplify-cli. Then clone it to your machine to work with it locally using one of the following methods:

    # HTTPS
git clone https://github.com/[username]/amplify-cli.git

# SSH
git clone [email protected]:[username]/amplify-cli.git

# GitHub CLI
gh repo clone [username]/amplify-cli

  5. Move into your project folder:

    cd amplify-cli

  6. Then, you can run the setup-dev script, which installs dependencies and performs initial configuration:

    # Linux / macOS
yarn && yarn setup-dev

# Windows
yarn && yarn setup-dev-win
## Preferably run in Git Bash

    Additional Instructions for Windows Users:

    Prior to running the setup-dev script:

    1. Install the Visual C++ Build Environment by installing Visual Studio Community Edition. When selecting options, only 'Desktop Development for C++' needs to be added.
    2. Open a terminal window/command prompt and run npm config edit and add or modify msvs_version setting to be your version of Visual Studio (e.g. msvs_version=22)
    3. If you run into the build error 'MSB8040: Spectre-mitigated libraries are required for this project' open the Visual Studio installer, press the 'Modify' button for your version of Visual Studio, then navigate to the 'Individual Components' and search for 'Spectre'. Install options that look like "MSVC v143 - VS 2022 C++ x64/x86 Spectre-mitigated libs (Latest)", you should only need the x86-64 version, but can optionally install versions for ARM and ARM64/ARM64EC.
    4. Go back to the terminal window/command prompt and navigate to the 'amplify-cli' folder and run yarn clean cache --all
    5. You should now be ready to run the setup-dev script

NOTE: Make sure to always sync your fork with dev branch of amplify-cli

Architecture of the codebase

Amplify CLI is a monorepo built with Yarn Workspaces and Lerna. All the categories of Amplify live within the packages/ directory in the root. Each category inside packages has its own src/ and package.json.

Packages inside Amplify CLI Monorepo

Steps towards contributions

  • To make changes with respect to a specific category, go into packages/[category].
  • Make changes to required file.
  • Write unit tests
  • Yarn build
  • Run test suite
  • Test in sample app using amplify-dev
  • Submit a PR

Pull Requests

Pull requests are welcome!

You should open an issue to discuss your pull request, unless it's a trivial change. It's best to ensure that your proposed change would be accepted so that you don't waste your own time. If you would like to implement support for a significant feature that is not yet available, please talk to us beforehand to avoid any duplication of effort. Additionally, please be mindful of the length of the pull request - if your change requires more than 12 file changes, consider breaking the change down into smaller, non-dependent changes. This includes any changes that may be added as a result of the linter.

Pull requests should be opened against dev.

Don't include any build files i.e. dist/ in your PR. These will be built upon publish to npm and when a release is created on GitHub.

Labels

If the change is a breaking change (as defined by semantic versioning), please add the semver-major label to your pull request on GiHub.

Steps

  1. Go through the Local Environment Setup
  2. Within your local fork, create a new branch based on the issue you're addressing - e.g. git checkout -b category-auth/admin-auth-support
    • Use grouping tokens at the beginning of the branch names. For e.g, if you are working on changes specific to amplify-category-auth, then you could start the branch name as category-auth/...
    • Use slashes to separate parts of branch names
  3. Before your first commit, install git-secrets plugin
  4. Once your work is committed and you're ready to share, run yarn test. Manually test your changes in a sample app with different edge cases and also test across different platforms if possible.
  5. Run yarn lint-fix to find and fix any linting errors
  6. Run yarn prettier-changes to fix styling issues
  7. Then, push your branch: git push origin HEAD (pushes the current branch to origin remote)
  8. Open GitHub to create a PR from your newly published branch. Fill out the PR template and submit a PR.
  9. Finally, the Amplify CLI team will review your PR. Add reviewers based on the core member who is tracking the issue with you or code owners. In the meantime, address any automated check that fail (such as linting, unit tests, etc. in CI)

Bug Reports

Bug reports and feature suggestions are always welcome. Good bug reports are extremely helpful, so thanks in advance!

When filing a bug, please try to be as detailed as possible. In addition to the bug report form information, details like these are incredibly useful:

  • A reproducible test case or series of steps
  • The date/commit/version(s) of the code you're running
  • Any modifications you've made relevant to the bug
  • Anything unusual about your environment or deployment

Guidelines for bug reports:

  • Check to see if a duplicate or closed issue already exists!
  • Provide a short and descriptive issue title
  • Remove any sensitive data from your examples or snippets
  • Format any code snippets using Markdown syntax
  • If you're not using the latest version of the CLI, see if the issue still persists after upgrading - this helps to isolate regressions!

Finally, thank you for taking the time to read this, and taking the time to write a good bug report.

Commits

Commit messages should follow the conventional commits specification. For example:

git commit -m 'docs(cli): correct spelling of CHANGELOG'

Valid commit types are as follows:

  • build
  • chore
  • ci
  • docs
  • feat
  • fix
  • perf
  • refactor
  • style
  • test

Git Hooks

You will notice the extra actions carried out when you run the git commit or git push commands on this monorepo, that's because the following git hooks are configured using husky (you can see them in .husky file):

NOTE: To ensure those git hooks properly execute, run yarn or npm install at the root of this monorepo to install the necessary dev dependency packages.

"commit-msg" hook:

The "commit-msg" hook ensures the commit message follows the Conventional Commits convention, so that proper CHANGELOG.md files and package versions are maintained.

"pre-commit" hook:

The "pre-commit" hook runs the verify-commit script and runs eslint of changed files.

"pre-push" hook:

The "pre-push" hook will build test files and run the split-e2e-tests script to ensure the correct configuration file is generated for our CI/CD workflow.

Tests

Please ensure that your change still passes unit tests. It's OK if you're still working on tests at the time that you submit, but be prepared to be asked about them. Pull requests should contain tests as appropriate. Bugfixes should contain tests that exercise the corrected behavior (i.e., the test should fail without the bugfix and pass with it), and new features should be accompanied by tests exercising the feature.

How to Find and Create Unit Tests

Unit tests should be located under .../src/__tests__/ with the expectation that the directory tree under __tests__ mirrors that of src. In general it is expected that unit tests take the name of the file they test. For example:

File:

amplify-category-function/src/provider-utils/service-walkthroughs/execPermissionsWalkthough.ts

Unit Tests:

amplify-category-function/src/__tests__/provider-utils/service-walkthroughs/execPermissionsWalkthrough.test.ts

Running Unit Tests

To run the test suite:

yarn test

Or, to run the tests for a specific package,

cd packages/amplify-category-function
yarn test

A preferred workflow is to watch tests while writing code. For example, you can open a terminal in the directory of the package you are updating and watch tests in that package.

cd packages/amplify-category-function
yarn test --watch

Using the watch option, the unit tests will re-run every time a change is made to the code.

Amplify CLI uses Jest for testing. See the Jest Documentation for more information.

End-To-End Tests

End-to-end tests can be found in packages/amplify-e2e-tests. It is not recommended to run all of these tests at a time but to, instead, run the tests in a single file in order to debug, fix, or update it.

You can run an end to end test with the following:

cd packages/amplify-e2e-tests
yarn e2e src/__tests__/some_e2e_test.test.ts

You can also run a specific test from a file using:

yarn e2e src/__tests__/some_e2e_test.test.ts -t name-of-test

End to end tests generally provision real resources and attempt to tear them down again after the test has run. If tests are interrupted due to manual intervention or some other issue, resources may stick around and require manual removal.

Code Coverage

Code coverage can be seen by running all tests, yarn test, then running yarn coverage:collect. The coverage is collected in the coverage/ file at the root of the project.

The coverage can be viewed in a browser by opening coverage/lcov-report/index.html, or in IDE tools utilizing coverage/lcov.info.

Manual Testing

To test your category in sample application, do the following:

cd <your-test-front-end-project>
amplify-dev init
amplify-dev <your-category> <subcommand>

Debugging

Sometimes issues can be solved by doing a clean and fresh build. To start from a clean project state:

  1. Removes ./lib, tsconfig.tsbuildinfo, and node_modules from all packages and run their clean script:

    yarn clean

  2. Remove all unstaged changes and everything listed in the .gitignore file:

    git clean -fdx

  3. Reset dev branch to that of origin/dev:

    git fetch origin && git checkout --track origin/dev -B dev

  4. Then, run the setup-dev script:

    # Linux / macOS
yarn setup-dev

# Windows
yarn setup-dev-win

If you are using Visual Studio Code, the built-in Javascript Debug Terminal is useful for performing runtime debugging.

In order to use the terminal, build the application. Then, execute the built binary, amplify-dev, from the Javascript Debug Terminal. See VSCode's documentation for more information.

Code Style

Generally, match the style of the surrounding code. Please ensure your changes don't wildly deviate from those rules. You can run yarn lint-fix to identify and automatically fix most style issues.

Finding Contributions

Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any help-wanted or good first issue is a great place to start.

You could also contribute by reporting bugs, reproduction of bugs with sample code, documentation and test improvements.

Community

Join the Discord Server. If it's your first time contributing, checkout the #contributing channel.

Code of Conduct

This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Security Issue Reporting

If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our vulnerability reporting page. Please do not create a public GitHub issue.

Licensing

AWS Amplify CLI is Apache 2.0-licensed. Contributions you submit will be released under that license.

We may ask you to sign a Contributor License Agreement (CLA) for larger changes.