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
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+31-4Lines changed: 31 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,13 @@
1
-
# <aname='#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)
2
7
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:
4
9
5
-
## Development - applicable to issues and pull requests
10
+
#<aname='#development'>Development - applicable to issues and pull requests</a>
6
11
7
12
1.`status: in-review` this is the initial status of an issue. If the label is not placed, go ahead and place it.
8
13
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:
24
29
25
30
`status: in-review` => `status: not-to-fix` (Issue can be closed)
26
31
27
-
## Testing - applicable to pull requests
32
+
#<aname='#testing'>Testing - applicable to pull requests</a>
28
33
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`.
29
34
2.`status: in-test` place this status once you pick up the pull request for testing.
30
35
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:
39
44
40
45
> 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).
41
46
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
+
# <aname='#fixing'> Fixing bugs and adding new samples</a>
49
+
## <aname='#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
+
## <aname='#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.
0 commit comments