You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Issue number: N/A
---------
<!-- Please do not submit updates to dependencies unless it fixes an
issue. -->
<!-- Please try to limit your pull request to one type (bugfix, feature,
etc). Submit multiple pull requests if needed. -->
## What is the current behavior?
<!-- Please describe the current behavior that you are modifying. -->
## What is the new behavior?
<!-- Please describe the behavior or changes that are being added by
this PR. -->
- Syncs the `feature.8.0` branch with the latest from `main`.
## Does this introduce a breaking change?
- [ ] Yes
- [x] No
<!--
If this introduces a breaking change:
1. Describe the impact and migration path for existing applications
below.
2. Update the BREAKING.md file with the breaking change.
3. Add "BREAKING CHANGE: [...]" to the commit description when merging.
See
https://github.com/ionic-team/ionic-framework/blob/main/docs/CONTRIBUTING.md#footer
for more information.
-->
## Other information
<!-- Any other information that is important to this PR such as
screenshots of how the component looks before and after the change. -->
Copy file name to clipboardExpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ Issue number: resolves #
25
25
If this introduces a breaking change:
26
26
1. Describe the impact and migration path for existing applications below.
27
27
2. Update the BREAKING.md file with the breaking change.
28
-
3. Add "BREAKING CHANGE: [...]" to the commit description when merging. See https://github.com/ionic-team/ionic-framework/blob/main/.github/CONTRIBUTING.md#footer for more information.
28
+
3. Add "BREAKING CHANGE: [...]" to the commit description when merging. See https://github.com/ionic-team/ionic-framework/blob/main/docs/CONTRIBUTING.md#footer for more information.
With the `dev` command, Ionic components will be built with [Stencil](https://stenciljs.com/), changes to source files are watched, a local http server will startup, and http://localhost:3333/ will open in a browser.
24
-
25
-
### 4. Preview
26
-
27
-
Navigate to http://localhost:3333/src/components/. Each component has small e2e apps found in the `test` directory, for example: http://localhost:3333/src/components/button/test/basic
28
-
29
-
As changes are made in an editor to source files, the e2e app will live-reload.
30
-
31
-
## How to contribute
32
-
33
-
1.`npm start` allows you to modify the components and have live reloading, just like another ionic app.
34
-
35
-
2. When everything looks good, run `npm run validate` to verify the tests linter and production build passes.
36
-
37
-
38
-
# Deploy
39
-
40
-
1.`npm run prepare.deploy`
41
-
2. Review/update changelog
42
-
3. Commit updates using the package name and version number as the commit message.
43
-
4.`npm run deploy`
44
-
5.:tada:
4
+
This file has been moved to [/docs/core/testing/preview-changes.md](/docs/core/testing/preview-changes.md).
*[Creating a Good Code Reproduction](#creating-a-good-code-reproduction)
8
+
-[Using VS Code on Windows](#using-vs-code-on-windows)
8
9
-[Creating a Pull Request](#creating-a-pull-request)
9
10
*[Requirements](#requirements)
10
11
*[Setup](#setup)
@@ -81,6 +82,19 @@ Without a reliable code reproduction, it is unlikely we will be able to resolve
81
82
***No secret code needed:** Creating a minimal reproduction of the issue prevents you from having to publish any proprietary code used in your project.
82
83
***Get help fixing the issue:** If we can reliably reproduce an issue, there is a good chance we will be able to address it.
83
84
85
+
## Using VS Code on Windows
86
+
87
+
To contribute on Windows, do the following:
88
+
89
+
- Configure VS Code to read/save files using line breaks (LF) instead of carriage returns (CRLF). Set it globally by navigating to: Settings -> Text Editor -> Files -> Eol. Set to `\n`.
90
+
91
+
- You can optionally use the following settings in your `.vscode/settings.json`:
92
+
```json
93
+
{ "files.eol": "\n" }
94
+
```
95
+
96
+
- Check that the Git setting `core.autocrlf` is set to `false`: run `git config -l | grep autocrlf`. Switch it to false using: `git config --global core.autocrlf false`.
97
+
- If you've already cloned the `ionic-framework` repo, the files may already be cached as LF. To undo this, you need to clean the cache files of the repository. Run the following (make sure you stage or commit your changes first): `git rm --cached -r .` then `git reset --hard`.
> If you are using a Windows machine, you will need to configure your local development environment to use the correct line endings.
265
+
> - Check that the Git setting `core.autocrlf` is set to `false`: run `git config -l | grep autocrlf`. Switch it to false using: `git config --global core.autocrlf false`.
266
+
> - If you've already cloned the `ionic-docs` repo, the files may already be cached as LF. To undo this, you need to clean the cache files of the repository. Run the following (make sure you stage or commit your changes first): `git rm --cached -r .` then `git reset --hard`.
267
+
268
+
269
+
270
+
249
271
1. Run `npm run lint` to lint the TypeScript and Sass.
250
272
2. If there are lint errors, run `npm run lint.fix` to automatically fix any errors. Repeat step 1 to ensure the errors have been fixed, and manually fix them if not.
251
273
3. To lint and fix only TypeScript errors, run `npm run lint.ts` and `npm run lint.ts.fix`, respectively.
This documentation includes guidelines on contributing, coding conventions, best practices, testing steps, and more. It should serve as a collective resource for all documentation related to developing Ionic Framework.
11
+
</p>
12
+
13
+
## What is Ionic Framework?
14
+
15
+
Ionic Framework is an open source app development toolkit for building modern, fast, top-quality cross-platform native and Progressive Web Apps from a single codebase with JavaScript and the Web.
16
+
17
+
It is based on <ahref="https://www.webcomponents.org/introduction">Web Components</a>, which enables significant performance, usability, and feature improvements alongside support for popular web frameworks like <ahref="https://angular.io/">Angular</a>, <ahref="https://reactjs.com/">React</a>, and <ahref="https://vuejs.org/">Vue</a>.
0 commit comments