Skip to content

Latest commit

 

History

History
246 lines (157 loc) · 7.77 KB

CONTRIBUTING.md

File metadata and controls

246 lines (157 loc) · 7.77 KB
Raw

Contributing

Analog is an MIT-licensed open source project with its ongoing development made by contributors.

Contributing to the framework

Folder structure

Source code for the Analog framework exists under the packages/ folder. To contribute features or bug fixes to the framework, locate the relevant code in one of the packages sub-folder. In addition to the create-analog sub-folder, there is a sub-folder for each of the npm packages in the @analogjs/* scope:

  • packages/create-analog → create-analog
  • packages/vite-plugin-angular → @analogjs/vite-plugin-angular

Setup

Analog uses Yarn Classic to manage its dependencies.

Before opening a pull request, run the following command from the root folder to make sure your development dependencies are up-to-date:

yarn

Running locally

To serve the example application locally, run the following command from the root folder:

yarn dev

Build

Analog uses Nx for builds. To build all projects locally, run the following command from the root folder:

yarn build

Testing

Analog uses Jest for tests. To test all projects locally, run the following command from the root folder:

yarn test

Contributing to the docs and analogjs.org website

Folder struture

Source code for the Analog docs and the analogjs.org website exists under the apps/docs-app project folder. To contribute documentation or website content, locate the relevant source code in one of the sub-folders:

  • blog - Blog (unused).
  • docs - Documentation pages with React MDX support.
  • src/components - React components.
  • src/css - Global styles.
  • src/pages - React page components.
  • static - Images and other static assets.

Setup

Analog uses Yarn Classic to manage its dependencies.

Before opening a pull request, run the following command from the root folder to make sure your development dependencies are up-to-date:

yarn

Running locally

Analog uses Docusaurus to develop the docs and analogjs.org website. Run the following command from the apps/docs-app folder to serve the website:

yarn nx serve

or alternatively run this command from the root folder:

yarn nx serve docs-app

Once the development server is up and running, you can preview the docs and website by visiting http://localhost:3000.

Build

Analog uses Nx to build the docs and analogjs.org website. To build the website locally, run the following command from the apps/docs-app folder:

yarn nx build

or alternatively run this command from the root folder:

yarn nx build docs-app

Running static website locally

To run the the generated static website locally, run the following command from the apps/docs-app folder:

yarn nx serve-static

or alternatively run this command from the root folder:

yarn nx serve-static docs-app

Submitting pull requests

Please follow these basic steps to simplify pull request reviews. If you don't you'll probably just be asked to anyway.

  • Please rebase your branch against the current master.
  • Run the Setup command to make sure your development dependencies are up-to-date.
  • Please ensure the test suite passes before submitting a PR.
  • If you've added new functionality, please include tests which validate its behavior.
  • Make reference to possible issues on PR comment.

Submitting bug reports

  • Search through issues to see if a previous issue has already been reported and/or fixed.
  • Provide a small reproduction using a StackBlitz project or a GitHub repository.
  • Please detail the affected browser(s) and operating system(s).
  • Please be sure to state which version of Angular, node and npm you're using.

Submitting new features

  • We value keeping the API surface small and concise, which factors into whether new features are accepted.
  • Submit an issue with the prefix RFC: with your feature request.
  • The feature will be discussed and considered.
  • Once the PR is submitted, it will be reviewed and merged once approved.

Questions and requests for support

Questions and requests for support should not be opened as issues and should be handled in the following ways:

Commit message guidelines

We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to generate the changelog.

Commit message format

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

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

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

Any line of the commit message cannot be longer than 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.

The footer should contain a closing reference to an issue if any.

Samples: (even more samples)

docs(changelog): update changelog to beta.5

fix(release): need to depend on latest rxjs and zone.js

The version in our package.json gets copied to the one we publish, and users need the latest of these.

Revert

If the commit reverts a previous commit, it should begin with revert:, followed by the header of the reverted commit. In the body it should say: This reverts commit <hash>., where the hash is the SHA of the commit being reverted.

Type

Must be one of the following:

  • build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
  • ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)
  • test: Adding missing tests or correcting existing tests

Scope

The scope should be the name of the npm package affected (as perceived by the person reading the changelog generated from commit messages.

The following is the list of supported scopes:

  • vite-angular-plugin
  • create-analog

Subject

The subject contains a succinct description of the change:

  • use the imperative, present tense: "change" not "changed" nor "changes"
  • don't capitalize the first letter
  • no dot (.) at the end

Body

Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.

Footer

The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.

Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.

Example:

feat(scope): commit message

BREAKING CHANGES:

Describe breaking changes here

BEFORE:

Previous code example here

AFTER:

New code example here