-
Notifications
You must be signed in to change notification settings - Fork 13.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
87 changed files
with
1,865 additions
and
492 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,118 +1,115 @@ | ||
| ### Creating an Issue | ||
| # Contributing | ||
|
|
||
| If you have a question on how something works, or its expected functionality, you might want to visit the [Ionic Forum](http://forum.ionicframework.com/) first. | ||
| Thanks for your interest in contributing to the Ionic Framework! :tada: | ||
|
|
||
| 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](https://github.com/driftyco/ionic/issues?state=open). You can search through existing issues to see if someone's reported one similar to yours. | ||
|
|
||
| Next [create a new issue](https://github.com/driftyco/ionic/issues/new) that thoroughly explains the problem, how to reproduce the issue, and provide any additional information such as code examples and error logs. | ||
| ## Contributing Etiquette | ||
|
|
||
| ### Issue Etiquette Guidelines | ||
| Please see our [Contributor Code of Conduct](./CODE_OF_CONDUCT.md) for information on our rules of conduct. | ||
|
|
||
| Poor attitude, ranting, name-calling, bullying, being a jerk, complaining, or spamming are fruitless and unacceptable. Issues that violate the open source spirit of this community, or any of the guidelines listed here, may result in your Issue being deleted or reposted to our Forum, a better place for debate and discussion. If you wish to contribute, either make your response respectful or do not bother to respond. You’ll find it’s pretty ineffective. | ||
|
|
||
| Simply put: be respectful and act like an adult. Critiques are better made on the Forum. If you can’t do that, this isn’t a community for you. | ||
| ## Creating an Issue | ||
|
|
||
| See our [Code of Conduct](./CODE_OF_CONDUCT.md) for more info. | ||
| If you have a question about using the framework, please ask on the [Ionic Forum](http://forum.ionicframework.com/) or in the [Ionic Worldwide Slack](http://ionicworldwide.herokuapp.com/) group. | ||
|
|
||
| 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](https://github.com/driftyco/ionic/issues?utf8=%E2%9C%93&q=is%3Aissue). 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. | ||
|
|
||
| ### Pull Request Guidelines | ||
| Next, [create a new issue](https://github.com/driftyco/ionic/issues/new) that thoroughly explains the problem. Please fill out the populated issue form before submitting the issue. | ||
|
|
||
| Please use [Commitizen](https://github.com/commitizen/cz-cli#installing-the-command-line-tool) to commit to this repository. This ensures your commits will match our git conventions. It can be installed by running the following command (add sudo if on OSX/Linux): | ||
|
|
||
| ``` | ||
| npm install -g commitizen | ||
| ``` | ||
| ## Creating a Pull Request | ||
|
|
||
| Then, when you want to commit, instead of writing `git commit` you will write: | ||
| We appreciate you taking the time to contribute! Before submitting a pull request, we ask that you please [create an issue](#creating-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. | ||
|
|
||
| ``` | ||
| git cz | ||
| ``` | ||
| Looking for an issue to fix? Make sure to look through our issues with the [help wanted](https://github.com/driftyco/ionic/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) label! | ||
|
|
||
| This will prompt you with some questions. | ||
| ### Setup | ||
|
|
||
| When in doubt, keep your pull requests small. To give a PR the best chance of getting accepted, do not bundle more than one "feature" or bug fix per PR. Doing so makes it very hard to accept it if one of the fixes has issues. | ||
| 1. Fork the repo. | ||
| 2. Clone your fork. | ||
| 3. Make a branch for your change. | ||
| 4. Run `npm install` (make sure you have [node](https://nodejs.org/en/) and [npm](http://blog.npmjs.org/post/85484771375/how-to-install-npm) installed first) | ||
|
|
||
| It's always best to create two smaller PRs than one big one. | ||
|
|
||
| ### Style | ||
| ### Modifying Components | ||
|
|
||
| Always use two spaces, no tabs. This goes for any HTML, CSS, or Javascript. | ||
| 1. Make any changes to the component. | ||
| 2. Modify the e2e test in the `test/` directory under the component directory, if possible. If the test does not exist and it is possible to show the change, please create a new test in a directory called `basic/`. | ||
|
|
||
| #### Sass Guidelines | ||
| #### TypeScript Changes | ||
|
|
||
| ##### Sass Linter | ||
| 1. If there is a `*.spec.ts` file located in the `test/` folder, update it to include a karma test for your change, if needed. If this file doesn't exist, please notify us. | ||
| 2. Run `gulp karma` to make sure all tests are working, regardless if a test was added. | ||
| 3. Run `gulp tslint` and fix any linter errors. | ||
|
|
||
| Run [Sass Linter](https://github.com/brigade/scss-lint) to ensure the css/sass matches our conventions (requires Ruby) | ||
| #### Sass Changes | ||
|
|
||
| 1. Install the linter: `gem install scss_lint` | ||
| 2. Make sure to run the linter at the root of the repository where the `.scss-lint.yml` file is located | ||
| 3. For all component Sass files: `scss-lint ionic/**/**/*.scss` | ||
| 4. For a specific Sass file: `scss-lint ionic/components/toolbar/toolbar.ios.scss` | ||
| 1. If the css property is something that the user may want to override and it won't break the component layout, it should be given a Sass variable. See our [doc on naming Sass variables](https://docs.google.com/document/d/1OyOyrRE5lpB_9mdkF0HWVQLV97fHma450N8XqE4mjZQ/edit?usp=sharing). | ||
| 2. After any changes to the Sass files run the [Sass Linter](https://github.com/brigade/scss-lint), and fix any linter errors: | ||
| - Requires [Ruby](https://www.ruby-lang.org/en/documentation/installation/). **Skip this step entirely if you are unable to install Ruby.** | ||
| - Install the linter: `gem install scss_lint` | ||
| - Make sure to run the linter at the root of the repository. | ||
| - To check all component Sass files: `scss-lint ionic/**/**/*.scss` | ||
| - To check a specific Sass file: `scss-lint ionic/components/toolbar/toolbar.ios.scss` | ||
|
|
||
|
|
||
| ##### Variable Naming Conventions | ||
| #### Viewing Changes | ||
|
|
||
| The Sass variable should start with the component name: | ||
| 1. Run the gulp watch task for e2e tests: `gulp watch.e2e` | ||
| 2. Launch your browser and navigate to `http://localhost:8000/dist/e2e` | ||
| 3. From here, navigate to the component you are changing. | ||
| 4. Any changes to the e2e tests in the `test/` directory will show here. | ||
| 5. If your changes look good, you're ready to [commit](#committing)! | ||
|
|
||
| ``` | ||
| $alert | ||
| $action-sheet | ||
| $badge | ||
| $toolbar | ||
| ``` | ||
|
|
||
| Then it should use the mode abbreviation (ios, md, wp): | ||
| #### Adding Documentation | ||
|
|
||
| ``` | ||
| $alert-md | ||
| $action-sheet-ios | ||
| $badge-md | ||
| $toolbar-wp | ||
| ``` | ||
| 1. To add or modify API Documentation for a component, it should be added/changed in the component's TypeScript (`*.ts`) file, prior to the Class definition. For example, `Badge` looks similar to this: | ||
|
|
||
| Next should be the css property it is affecting, for example: | ||
| ``` | ||
| /** | ||
| * @name Badge | ||
| * @module ionic | ||
| * @description | ||
| * Badges are simple components in Ionic containing numbers or text. | ||
| * | ||
| * @see {@link /docs/v2/components/#badges Badges Component Docs} | ||
| * @demo /docs/v2/demos/badge/ | ||
| **/ | ||
| ``` | ||
|
|
||
| ``` | ||
| $alert-md-max-width | ||
| $action-sheet-ios-background | ||
| $badge-md-border-radius | ||
| $toolbar-wp-padding | ||
| ``` | ||
| where `@name` is the Class name, `@description` is the description displayed on the documentation page, `@see` links to any related pages, and `@demo` links to the API demo located in the `demos` folder. | ||
| 2. In order to run API documentation locally, you will need to clone the `ionic-site` repo as a sibling to the `ionic` repo and then run it: https://github.com/driftyco/ionic-site#local-build | ||
| 3. Then, run `gulp docs` in the `ionic` repo every time you make a change and the site will update. | ||
| 4. If the change affects the component documentation, create an issue on the `ionic-site` repo: https://github.com/driftyco/ionic-site/issues | ||
|
|
||
| If it is affecting a component inside of the top level component, that should come next instead of the css property: | ||
|
|
||
| ``` | ||
| $alert-md-title | ||
| $alert-md-sub-title | ||
| $alert-md-message | ||
| $action-sheet-ios-title | ||
| $action-sheet-ios-button | ||
| ``` | ||
| #### Adding Demos | ||
|
|
||
| Followed by the css property of that component: | ||
| 1. Create or modify the demo in the `demos/` folder. | ||
| 2. If it is new, link to the demo in the component's TypeScript (`*.ts`) file (under `ionic/components`) by adding a link to it in the documentation using `@demo`, for example: | ||
|
|
||
| ``` | ||
| $alert-md-title-font-size | ||
| $alert-md-sub-title-font-size | ||
| $alert-md-message-padding | ||
| $action-sheet-ios-title-color | ||
| $action-sheet-ios-button-background | ||
| ``` | ||
| ``` | ||
| /** | ||
| * @name Badge | ||
| * | ||
| * ... | ||
| * | ||
| * @demo /docs/v2/demos/badge/ | ||
| **/ | ||
| ``` | ||
| 3. Run `gulp watch.demos` to watch for changes to the demo | ||
| 4. Navigate to `http://localhost:8000/dist/demos/` and then to your component's demo to view it. | ||
| 5. If the change affects the component demos, create an issue on the `ionic-site` repo: https://github.com/driftyco/ionic-site/issues | ||
|
|
||
| If the variable only applies to a specific state, that should come last (hover, focused, activated, etc): | ||
| ### Committing | ||
|
|
||
| ``` | ||
| $action-sheet-ios-button-background-activated | ||
| $alert-md-input-border-width-focused | ||
| ``` | ||
| 1. Install [Commitizen](https://github.com/commitizen/cz-cli#installing-the-command-line-tool) (add sudo if on OSX/Linux): `npm install -g commitizen` | ||
| 2. Use commitizen to commit instead of `git commit`: `git cz` | ||
| 3. This will prompt you with questions and commit when you are finished. | ||
| 4. Submit the Pull Request! | ||
|
|
||
| **Should I use `background` or `bg`?** | ||
| `background` | ||
|
|
||
| **Should I use `background` or `background-color`?** | ||
| `background` so users can override backgrounds in Sass variables using images and etc | ||
|
|
||
| ### License | ||
| ## License | ||
|
|
||
| By contributing your code to the driftyco/ionic GitHub Repository, you agree to license your contribution under the MIT license. |
Binary file not shown.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.