Skip to content

Commit cd44ad3

Browse files
committed
Merge branch 'vNext' of https://github.com/IgniteUI/igniteui-angular-samples into vNext
2 parents 68e12a3 + 61a71a7 commit cd44ad3

46 files changed

Lines changed: 607 additions & 273 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/CONTRIBUTING.md

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
1-
# <a name='#workflow'>Workflow</a>
1+
## In this topic
2+
### 1. [Development - applicable to issues and pull requests](#development)
3+
### 2. [Testing - applicable to pull requests](#testing)
4+
### 3. [Fixing bugs and adding new samples](#fixing)
5+
### 3.1. [Bug fixing guidelines](#bug)
6+
### 3.2. [Adding new samples guidelines](#new-sample)
27

3-
When working on an issue for the Ignite UI Angular Samples, you need to be aware of and to follow a correct status workflow. We have created a number of status labels in order to communicate well what the current status of a single issue/pull request is. The statuses are as follows:
8+
When working on an issue/new sample for the Ignite UI Angular Samples, you need to be aware of and to follow a correct status workflow. We have created a number of status labels in order to communicate well what the current status of a single issue/pull request is. The statuses are as follows:
49

5-
## Development - applicable to issues and pull requests
10+
# <a name='#development'>Development - applicable to issues and pull requests</a>
611

712
1. `status: in-review` this is the initial status of an issue. If the label is not placed, go ahead and place it.
813
2. `status: in-development` this is the status once you start working on an issue. Assign the issue to yourself if it hasn't been assigned already, remove the previous status and assign status: in-development.
@@ -24,7 +29,7 @@ Example status workflows:
2429

2530
`status: in-review` => `status: not-to-fix` (Issue can be closed)
2631

27-
## Testing - applicable to pull requests
32+
# <a name='#testing'>Testing - applicable to pull requests</a>
2833
1. `status: awaiting-test` this is the initial status of pull requests. If you're performing the pull request, please place this status on it. Pull requests are accepted if and only if all status checks pass, review is performed, and the pull request has been tested and contains `status: verified`.
2934
2. `status: in-test` place this status once you pick up the pull request for testing.
3035
3. `status: verified` place this status once you've tested the pull request, have verified that the issue is fixed, and have included all necessary automated tests for the issue.
@@ -39,3 +44,25 @@ Example status workflows:
3944

4045
> Note: Testing a PR from Angular Samples (when new sample is added) with combination of PR related to topic update (or when new topic is added).
4146
Open both repositories ([DocFX Site Builder](https://github.com/IgniteUI/igniteui-docfx) and [Angular Demos](https://github.com/IgniteUI/igniteui-angular-samples)) and perform `npm start`. This will start both projects and you will see the embed sample in your topic under `localhost`.
47+
48+
# <a name='#fixing'> Fixing bugs and adding new samples</a>
49+
## <a name='#bug'> Bug fixing guidelines</a>
50+
51+
1. Depending on where the bug was found `the current version` or the `ongoing release version`, checkout a development branches from `vNext` or/and `master` branch. `vNext` is the version that is going to be used upon release (next version), and `master` is the branch with the current state (current version). If the change/fix is applicable only to the ongoing release branch (`vNext`) there is no need to cherry-pick to `master` branch as the change/fix/feature will be pushed to `master` branch upon release.
52+
2. Run lint
53+
3. Pull request your changes and reference the issue. Use the enforced commit message format with applicable type, scope, etc.
54+
4. Don't forget to make the necessary status updates, as described in the workflow section.
55+
56+
**Example workflow**
57+
When bug fixes are applicable to both `vNext` and `master` branches the process will look like this:
58+
59+
1. Checkout new branch from `vNext`. For code example purposes let's say the new branch is called `fixing-bug-5423-vNext`.
60+
2. Commit your changes to your `fixing-bug-5423-vNext` branch.
61+
3. Push and PR to the `vNext` branch.
62+
4. Switch to the `master` branch.
63+
5. Create a new branch from `master`. For code example purposes let's say the new branch is called `fixing-bug-5423-master`.
64+
6. Cherry pick your commit from the `fixing-bug-5423-vNext` branch: `git cherry-pick ..`
65+
7. Push to your `fixing-bug-5423-master` branch and PR to the `master` branch.
66+
67+
## <a name='#new-sample'> Adding new samples guidelines </a>
68+
Depending on where the the new sample should be added, `the current version` or the `ongoing release version`, checkout a development branches from `vNext` or/and `master` branch. `vNext` is the version that is going to be used upon release (next version), and `master` is the branch with the current state (current version). If the new sample is applicable only to the ongoing release branch (`vNext`) there is no need to cherry-pick to `master` branch as the new sample will be pushed to `master` branch upon release.

live-editing/configs/GridConfigGenerator.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1356,9 +1356,9 @@ export class GridConfigGenerator implements IConfigGenerator {
13561356

13571357
],
13581358
appModuleConfig: new AppModuleConfig({
1359-
imports: ['GridValidatorServiceComponent', 'IgxGridModule', 'IgxFocusModule', 'IgxPreventDocumentScrollModule'],
1359+
imports: ['GridValidatorServiceComponent', 'IgxGridModule', 'IgxFocusModule', 'IgxPreventDocumentScrollModule', 'IgxSwitchModule'],
13601360
ngDeclarations: ['GridValidatorServiceComponent'],
1361-
ngImports: ['IgxPreventDocumentScrollModule', 'IgxGridModule', 'IgxFocusModule']
1361+
ngImports: ['IgxPreventDocumentScrollModule', 'IgxGridModule', 'IgxFocusModule', 'IgxSwitchModule']
13621362
})
13631363
}));
13641364

@@ -1416,7 +1416,7 @@ export class GridConfigGenerator implements IConfigGenerator {
14161416
appModuleConfig: new AppModuleConfig({
14171417
imports: ['IgxGridModule', 'GridSummaryExportComponent', 'IgxPreventDocumentScrollModule', 'IgxExcelExporterService'],
14181418
ngDeclarations: ['GridSummaryExportComponent'],
1419-
ngImports: ['IgxPreventDocumentScrollModule', 'IgxGridModule', 'IgxExcelExporterService'],
1419+
ngImports: ['IgxPreventDocumentScrollModule', 'IgxGridModule'],
14201420
ngProviders: ['IgxExcelExporterService']
14211421
})
14221422
}));

live-editing/configs/HierarchicalGridConfigGenerator.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -342,7 +342,7 @@ export class HierarchicalGridConfigGenerator implements IConfigGenerator {
342342
}));
343343

344344
configs.push(new Config({
345-
additionalFiles: ['/src/app/directives/prevent-scroll.directive.ts', '/src/app/data/hierarchical-data.ts'],
345+
additionalFiles: ['/src/app/directives/prevent-scroll.directive.ts', '/src/app/data/hierarchical-data.ts', '/src/app/services/svgIcons.ts'],
346346
appModuleConfig: new AppModuleConfig({
347347
imports: ['IgxHierarchicalGridModule', 'HGridPinningSampleComponent', 'IgxPreventDocumentScrollModule'],
348348
ngDeclarations: ['HGridPinningSampleComponent'],
@@ -942,9 +942,9 @@ export class HierarchicalGridConfigGenerator implements IConfigGenerator {
942942
'/src/app/data/hierarchical-data.ts'
943943
],
944944
appModuleConfig: new AppModuleConfig({
945-
imports: ['HierarchicalGridValidatorServiceComponent', 'IgxHierarchicalGridModule', 'IgxPreventDocumentScrollModule'],
945+
imports: ['HierarchicalGridValidatorServiceComponent', 'IgxHierarchicalGridModule', 'IgxPreventDocumentScrollModule', 'IgxSwitchModule'],
946946
ngDeclarations: ['HierarchicalGridValidatorServiceComponent'],
947-
ngImports: ['IgxPreventDocumentScrollModule', 'IgxHierarchicalGridModule']
947+
ngImports: ['IgxPreventDocumentScrollModule', 'IgxHierarchicalGridModule', 'IgxSwitchModule']
948948
})
949949
}));
950950

@@ -1005,7 +1005,7 @@ export class HierarchicalGridConfigGenerator implements IConfigGenerator {
10051005
appModuleConfig: new AppModuleConfig({
10061006
imports: ['IgxHierarchicalGridModule', 'HGridSummaryExportComponent', 'IgxPreventDocumentScrollModule', 'IgxExcelExporterService'],
10071007
ngDeclarations: ['HGridSummaryExportComponent'],
1008-
ngImports: ['IgxPreventDocumentScrollModule', 'IgxHierarchicalGridModule', 'IgxExcelExporterService'],
1008+
ngImports: ['IgxPreventDocumentScrollModule', 'IgxHierarchicalGridModule'],
10091009
ngProviders: ['IgxExcelExporterService']
10101010
}),
10111011
component: 'HGridSummaryExportComponent'

live-editing/configs/TreeGridConfigGenerator.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ export class TreeGridConfigGenerator implements IConfigGenerator {
221221

222222
// TreeGrid Column Pinning sample
223223
configs.push(new Config({
224-
additionalFiles: ['/src/app/directives/prevent-scroll.directive.ts', '/src/app/tree-grid/data/employees-flat-detailed.ts'],
224+
additionalFiles: ['/src/app/directives/prevent-scroll.directive.ts', '/src/app/tree-grid/data/employees-flat-detailed.ts', '/src/app/services/svgIcons.ts'],
225225
appModuleConfig: new AppModuleConfig({
226226
imports: ['IgxPreventDocumentScrollModule', 'IgxTreeGridModule', 'TreeGridColumnPinningSampleComponent', 'IgxIconModule'],
227227
ngDeclarations: ['TreeGridColumnPinningSampleComponent'],
@@ -1155,9 +1155,9 @@ export class TreeGridConfigGenerator implements IConfigGenerator {
11551155
],
11561156
appModuleConfig: new AppModuleConfig({
11571157
imports: ['IgxPreventDocumentScrollModule', 'IgxTreeGridModule', 'TreeGridValidatorServiceComponent',
1158-
'IgxButtonModule'],
1158+
'IgxButtonModule', 'IgxSwitchModule'],
11591159
ngDeclarations: ['TreeGridValidatorServiceComponent'],
1160-
ngImports: ['IgxPreventDocumentScrollModule', 'IgxTreeGridModule', 'IgxButtonModule']
1160+
ngImports: ['IgxPreventDocumentScrollModule', 'IgxTreeGridModule', 'IgxButtonModule', 'IgxSwitchModule']
11611161
})
11621162
}));
11631163

@@ -1206,7 +1206,7 @@ export class TreeGridConfigGenerator implements IConfigGenerator {
12061206
appModuleConfig: new AppModuleConfig({
12071207
imports: ['IgxPreventDocumentScrollModule', 'IgxTreeGridModule', 'TreeGridSummaryExportComponent', 'IgxIconModule', 'IgxExcelExporterService'],
12081208
ngDeclarations: ['TreeGridSummaryExportComponent'],
1209-
ngImports: ['IgxPreventDocumentScrollModule', 'IgxTreeGridModule', 'IgxIconModule', 'IgxExcelExporterService'],
1209+
ngImports: ['IgxPreventDocumentScrollModule', 'IgxTreeGridModule', 'IgxIconModule'],
12101210
ngProviders: ['IgxExcelExporterService']
12111211
}),
12121212
component: 'TreeGridSummaryExportComponent',

package-lock.json

Lines changed: 46 additions & 46 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)