Skip to content
This repository was archived by the owner on Apr 4, 2025. It is now read-only.

Commit bdb8e88

Browse files
committed
docs: several updates
1 parent 1ae3d8d commit bdb8e88

File tree

2 files changed

+12
-32
lines changed

2 files changed

+12
-32
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,7 @@ Please read and follow our [Code of Conduct](https://github.com/angular/code-of-
1212
## <a name="issue"></a> Open an Issue
1313

1414
If you find a bug in AngularHint, you can help us by submitting an issue to our
15-
[GitHub Repository](https://github.com/angular/angular-hint). If you can trace the issue to a specific AngularHint module, please go
16-
to the module's repository to submit the issue. The current repositories for AngularHint modules are:
17-
- [Angular Hint Controllers](https://github.com/angular/angular-hint-controllers)
18-
- [Angular Hint Directives](https://github.com/angular/angular-hint-directives)
19-
- [Angular Hint DOM](https://github.com/angular/angular-hint-dom)
20-
- [Angular Hint Events](https://github.com/angular/angular-hint-events)
21-
- [Angular Hint Interpolation](https://github.com/angular/angular-hint-interpolation)
22-
- [Angular Hint Modules](https://github.com/angular/angular-hint-modules)
15+
[GitHub Repository](https://github.com/angular/angular-hint).
2316

2417
To help us effectively address your issue, please follow these steps:
2518
1. Use GitHub to search for duplicate issues. If a similar issue already exists, add more
@@ -56,33 +49,21 @@ send us a Pull Request. Following these steps will help us to include your code:
5649
```
5750
3. Create your patch, **including appropriate test cases**
5851
4. Follow our [Coding Style Guidelines](#style)
59-
5. Run the AngularHint protractor testing suite using the `gulp` command, or run an AngularHint
60-
module's unit tests using `karma start`. Ensure that all tests pass.
52+
5. Run the AngularHint protractor testing suite using `yarn test-e2e`, or run an AngularHint
53+
module's unit tests using `yarn test-unit`. Ensure that all tests pass.
6154
6. Commit your changes using a descriptive commit message that follows our [commit guidelines](#commit)
6255
6356
```shell
6457
git commit -a
6558
```
6659
Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files.
67-
7. Build your changes locally to ensure all the tests pass
68-
For AngularHint:
69-
70-
```shell
71-
gulp
72-
```
73-
74-
For an AngularHint module:
75-
76-
```shell
77-
karma start
78-
```
79-
8. Push your branch to GitHub:
60+
7. Push your branch to GitHub:
8061
8162
```shell
8263
git push origin my-fix-branch
8364
```
84-
9. In GitHub, send a pull request to AngularHint or the appropriate AngularHint module
85-
10. If we suggest changes then:
65+
8. In GitHub, send a pull request to AngularHint.
66+
9. If we suggest changes then:
8667
- Make the required updates
8768
- Re-run the tests and ensure they are still passing
8869
- Rebase your branch and force push to your GitHub repository (this will update your PR):
@@ -91,7 +72,7 @@ send us a Pull Request. Following these steps will help us to include your code:
9172
git rebase master -i
9273
git push -f
9374
```
94-
11. After your pull request is merged you can delete your branch an pull the changes from the
75+
10. After your pull request is merged you can delete your branch an pull the changes from the
9576
main repository.
9677
9778
- Delete the remote branch:
@@ -121,8 +102,7 @@ send us a Pull Request. Following these steps will help us to include your code:
121102
122103
##<a name="style"></a> Coding Style Guidelines
123104
124-
To help keep the code in AngularHint and the AngularHint modules consistent, please follow
125-
these conventions.
105+
To help keep the code in AngularHint consistent, please follow these conventions.
126106
127107
###1. AngularHint Guidelines
128108
@@ -138,8 +118,8 @@ send us a Pull Request. Following these steps will help us to include your code:
138118

139119
- All features should be covered by appropriate tests. In AngularHint the e2e tests
140120
are run through protractor and contained in the `e2e` directory. In individual AngularHint
141-
modules the unit tests are run through karma. Check the existing tests in the module you are working
142-
with to see the conventions for that module.
121+
modules the unit tests are run through karma. Check the existing tests in the module you are
122+
working with to see the conventions for that module.
143123

144124
#### Coding
145125

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,11 @@ Example:
5151
## Building
5252

5353
```shell
54-
$ npm install
54+
$ yarn install
5555
```
5656

5757
```shell
58-
$ npm run build
58+
$ yarn build
5959
```
6060
##Example
6161
In the `example` directory, you can find a sample application that appears

0 commit comments

Comments
 (0)