Contributing to Ionic
Thanks for the interest in contributing to Ionic Framework!
Please see the Contributor Code of Conduct for information on the rules of conduct.
Creating an Issue
If you have a question about using the framework, please ask on the Ionic Forum.
It is required that you clearly describe the steps necessary to reproduce the issue you are running into. Although we would love to help our users as much as possible, diagnosing issues without clear reproduction steps is extremely time-consuming and simply not sustainable.
The issue list of the Ionic repository is exclusively for bug reports and feature requests. Non-conforming issues will be closed immediately.
Issues with no clear steps to reproduce will not be triaged. If an issue is labeled with "needs: reply" and receives no further replies from the author of the issue for more than 14 days, it will be closed.
If you think you have found a bug, or have a new feature idea, please start by making sure it hasn't already been reported. You can search through existing issues to see if there is a similar one reported. Include closed issues as it may have been closed with a solution.
Next, create a new issue that thoroughly explains the problem. Please fill out the populated issue form before submitting the issue.
Creating a Good Code Reproduction
What is a Code Reproduction?
A code reproduction is a small application that is built to demonstrate a particular issue. The code reproduction should contain the minimum amount of code needed to recreate the issue and should focus on a single issue.
Why Should You Create a Reproduction?
A code reproduction of the issue you are experiencing helps us better isolate the cause of the problem. This is an important first step to getting any bug fixed!
Without a reliable code reproduction, it is unlikely we will be able to resolve the issue, leading to it being closed. In other words, creating a code reproduction of the issue helps us help you.
How to Create a Reproduction
- Create a new Ionic application using one of our starter templates. The
blankstarter application is a great choice for this. You can create one using the following Ionic CLI command:
ionic start myApp blank
- Add the minimum amount of code needed to recreate the issue you are experiencing. Do not include anything that is not required to reproduce the issue. This includes any 3rd party plugins you have installed.
- Publish the application on GitHub and include a link to it when creating an issue.
- Be sure to include steps to reproduce the issue. These steps should be clear and easy to follow.
Benefits of Creating a Reproduction
- Uses the latest version of Ionic: By creating a new Ionic application, you are ensuring that you are testing against the latest version of the framework. Sometimes the issues you are experiencing have already been resolved in a newer version of the framework!
- Minimal surface area: By removing code that is not needed in order to reproduce the issue, it makes it easier to identify the cause of the issue.
- No secret code needed: Creating a minimal reproduction of the issue prevents you from having to publish any proprietary code used in your project.
- Get help fixing the issue: If we can reliably reproduce an issue, there is a good chance we will be able to address it.
Creating a Pull Request
We appreciate you taking the time to contribute! Before submitting a pull request, we ask that you please create an issue that explains the bug or feature request and let us know that you plan on creating a pull request for it. If an issue already exists, please comment on that issue letting us know you would like to submit a pull request for it. This helps us to keep track of the pull request and make sure there isn't duplicated effort.
Looking for an issue to fix? Make sure to look through our issues with the help wanted label!
- Download the installer for the LTS version of Node.js. This is the best way to also install npm.
- Fork the Ionic repository.
- Clone your fork.
- Create a new branch from master for your change.
- Navigate into the directory of the package you wish to modify (core, angular, etc.).
npm installto install dependencies for this package.
- Follow the steps for the specific package below.
- Locate the component(s) to modify inside
- Take a look at the Stencil Documentation and other components to understand the implementation of these components.
- Make your changes to the component. If the change is overly complex or out of the ordinary, add comments so we can understand the changes.
- Preview your changes locally.
- Modify the documentation if needed.
- Run lint on the directory and make sure there are no errors.
- Build the project.
- After the build is finished, commit the changes. Please follow the commit message format for every commit.
- Submit a Pull Request of your changes.
npm startfrom within the
- A browser should open at
- From here, navigate to one of the component's tests to preview your changes.
- If a test showing your change doesn't exist, add a new test or update an existing one.
- To test in RTL mode, once you are in the desired component's test, add
?rtl=trueat the end of the url; for example:
npm run lintto lint the TypeScript and Sass.
- If there are lint errors, run
npm run lint.fixto automatically fix any errors. Repeat step 1 to ensure the errors have been fixed, and manually fix them if not.
- To lint and fix only TypeScript errors, run
npm run lint.tsand
npm run lint.ts.fix, respectively.
- To lint and fix only Sass errors, run
npm run lint.sassand
npm run lint.sass.fix, respectively.
- Locate the
readme.mdfile in the component's directory.
- Modify the documentation above the line that says
<!-- Auto Generated Below -->in this file.
- To update any of the auto generated documentation below that line, make the relevant changes in the following places:
Usage: update the component's usage examples in the component's
Methods: update the component's TypeScript file (
CSS Custom Properties: update the component's main Sass file (
- Locate the test to modify inside the
test/folder in the component's directory.
- If a test exists, modify the test by adding an example to reproduce the problem fixed or feature added.
- If a new test is needed, the easiest way is to copy the
basic/directory from the component's
test/directory, rename it, and edit the content in both the
e2e.tsfile (see Screenshot Tests for more information on this file).
preview/directory is used in the documentation as a demo. Only update this test if there is a bug in the test or if the API has a change that hasn't been updated in the test.
- If the test exists in screenshot, there will be a file named
e2e.tsin the directory of the test.
- A screenshot test can be added by including this file and adding one or more
test()calls that include a call to
page.compareScreenshot(). See Stencil end-to-end testing and existing tests in
- Important: each
test()should have only one screenshot (
page.compareScreenshot()) call or it should check the expect at the end of each test. If there is a mismatch it will fail the test which will prevent the rest of the test from running, i.e. if the first screenshot fails the remaining screenshot calls would not be called unless they are in a separate test or all of the expects are called at the end.
- To run screenshot locally, use the following command:
npm run test.screenshot.
- To run screenshot for a specific test, pass the path to the test or a string to search for.
- For example, running all
npm run test.screenshot alert.
- Or, running the basic
npm run test.screenshot src/components/alert/test/basic/e2e.ts.
- Once all changes have been made and the documentation has been updated, run
npm run buildinside of the
coredirectory. This will add your changes to any auto-generated files, if necessary.
- Review the changes and, if everything looks correct, commit the changes.
- Make sure the build has finished before committing. If you made changes to the documentation, properties, methods, or anything else that requires an update to a generate file, this needs to be committed.
- After the changes have been pushed, publish the branch and create a pull request.
Submit Pull Request
- Create a new pull request with the
masterbranch as the
base. You may need to click on
compare across forksto find your changes.
- See the Creating a pull request from a fork GitHub help article for more information.
- Please fill out the provided Pull Request template to the best of your ability and include any issues that are related.
Commit Message Guidelines
We have very precise rules over how our git commit messages should be formatted. This leads to readable messages that are easy to follow when looking through the project history. We also use the git commit messages to generate our changelog. Our format closely resembles Angular's commit message guidelines.
Commit Message Format
We follow the Conventional Commits specification. A commit message consists of a header, body and footer. The header has a type, scope and subject:
The header is mandatory and the scope of the header is optional.
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.
If the prefix is
perf, it will appear in the changelog. However if there is any BREAKING CHANGE, the commit will always appear in the changelog.
Must be one of the following:
- feat: A new feature
- fix: A bug fix
- docs: Documentation only changes
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- refactor: A code change that neither fixes a bug nor adds a feature
- perf: A code change that improves performance
- test: Adding missing tests
- chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
The scope can be anything specifying place of the commit change. Usually it will refer to a component but it can also refer to a utility. For example
nav, etc. If you make multiple commits for the same component, please keep the naming of this component consistent. For example, if you make a change to navigation and the first commit is
fix(nav), you should continue to use
nav for any more commits related to navigation. As a general rule, if you're modifying a component use the name of the folder.
The subject contains succinct description of the change:
- use the imperative, present tense: "change" not "changed" nor "changes"
- do not capitalize first letter
- do not place a period
.at the end
- entire length of the commit message must not go over 50 characters
- describe what the commit does, not what issue it relates to or fixes
- be brief, yet descriptive - we should have a good understanding of what the commit does by reading the subject