Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
105 lines (76 loc) · 3.36 KB

CONTRIBUTING.md

File metadata and controls

105 lines (76 loc) · 3.36 KB

Contributing

📣 Support/Questions?: Please see our Support Page for general support questions. The issues on GitHub should be reserved for bug reports and feature requests.

Bug Reports

Run the command(s) with --verbose to produce debugging output. We may ask for the full command output, including debug statements.

Please also copy/paste the output of the ionic info command into your issue and be as descriptive as possible. Include any steps that might help us reproduce your issue.

Feature Requests

Post an issue describing your feature to open a dialogue with us. We're happy to hear from you!

Pull Requests

Pull requests are most welcome! But, if you plan to add features or do large refactors, please open a dialogue with us first by creating an issue. Small bug fixes are welcome any time.

Help Wanted

Looking for small issues to help with? You can browse the help wanted label. These are issues that have been marked as great opportunities for someone's first PR to the Ionic CLI. 😍

Local Setup

Structure

Our CLI is organized into a monorepo. Common tools, such as Typescript and jest, are installed in the base directory while package dependencies are each installed in their respective packages/**/node_modules directories.

Each packages/* folder represents a package on npm.

  • packages/ionic: Ionic CLI executable.
  • packages/@ionic/cli-utils: Ionic CLI library and utilities.
  • packages/@ionic/cli-plugin-*: Ionic CLI plugins.
  • packages/@ionic/cli-framework: Framework for command-line programs.
  • packages/@ionic/discover: Service discovery library used for ionic serve with the Ionic DevApp.
  • packages/@ionic/schematics-angular: Ionic Angular v4+ schematics for ionic generate.
  • packages/@ionic/v1-util: Utility CLI for Ionic v1 Apps, used by ionic serve.
  • packages/@ionic/lab: Utility CLI for Ionic Lab, used by ionic serve.

Toolset

  • npm 5 is required.
  • Node 8+ is required.
  • Our codebase is written in Typescript. If you're unfamiliar with Typescript, we recommend using VS Code and finding a tutorial to familiarize yourself with basic concepts.
  • Our test suite uses Jest.

Setup

  1. Fork the repo & clone it locally.
  2. npm install to install the dev tools.
  3. npm run bootstrap (will install package dependencies and link packages together)
  4. Optionally npm run link to make ionic and other bin files point to your dev CLI.
  5. npm run watch will spin up Typescript watch scripts for all packages.
  6. Typescript source files are in packages/**/src.
  7. Good luck! 💪 Please open an issue if you have questions or something is unclear.

Running Dev CLI

Switch to dev CLI:

$ npm uninstall -g ionic
$ npm run link

Switch back to stable CLI:

$ npm run unlink
$ npm install -g ionic
Code Structure

TODO: Be helpful about where to look for commands, utilities, etc.

Publishing Notes

Cancel any watch scripts before proceeding.

  • testing releases: npm run publish:testing
  • canary releases: npm run publish:canary
  • stable releases: npm run publish