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

Commit 87270cb

Browse files
committed
docs(*): update CONTRIBUTING.md and create DEVELOPERS.md
CONTRIBUTING.md - focus on basic info about issues and pull requests for new contributors - move development heavy info to DEVELOPERS.md + add links - remove outdated info DEVELOPERS.md - contains info about project setup, coding rules, and commit message guidelines from CONTRIBUTING.md - add and update info about writing docs from Wiki - add info about development setup from docs contribute.md - add info about running tests on Saucelabs / Browserstack Closes #7303 Closes #9444 Closes #16297
1 parent e06ebfd commit 87270cb

File tree

7 files changed

+675
-408
lines changed

7 files changed

+675
-408
lines changed

.github/ISSUE_TEMPLATE.md

+37-27
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,37 @@
1-
***Note*: for support questions, please use one of these channels: https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#question. This repository's issues are reserved for feature requests and bug reports.**
2-
3-
**Do you want to request a *feature* or report a *bug*?**
4-
5-
6-
7-
**What is the current behavior?**
8-
9-
10-
11-
**If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem via https://plnkr.co or similar (template: http://plnkr.co/edit/tpl:yBpEi4).**
12-
13-
14-
15-
**What is the expected behavior?**
16-
17-
18-
19-
**What is the motivation / use case for changing the behavior?**
20-
21-
22-
23-
**Which versions of Angular, and which browser / OS are affected by this issue? Did this work in previous versions of Angular? Please also test with the latest stable and snapshot (https://code.angularjs.org/snapshot/) versions.**
24-
25-
26-
27-
**Other information (e.g. stacktraces, related issues, suggestions how to fix)**
1+
<!--
2+
IF YOU DON'T FILL OUT THE FOLLOWING INFORMATION WE MIGHT CLOSE YOUR ISSUE WITHOUT INVESTIGATION
3+
-->
4+
5+
<!--
6+
- For *SUPPORT QUESTIONS*, use one of the
7+
[support channels](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#question).
8+
- Before submitting, please **SEARCH GITHUB** for a similar issue or PR. -->
9+
10+
**I'm submitting a ...**
11+
<!-- (check one with "x") -->
12+
- [ ] bug report
13+
- [ ] feature request
14+
- [ ] other <!--(Please do not submit support requests here - see above)-->
15+
16+
**Current behavior:**
17+
<!-- Describe how the bug manifests / how the current features are insufficient. -->
18+
19+
**Expected / new behavior:**
20+
<!-- Describe what the behavior would be without the bug / how the feature would improve AngularJS -->
21+
22+
**Minimal reproduction of the problem with instructions:**
23+
<!--
24+
If the current behavior is a bug or you can illustrate your feature request better with an example,
25+
please provide the *STEPS TO REPRODUCE* and if possible a *MINIMAL DEMO* of the problem via
26+
https://plnkr.co or similar (you can use this template as a starting point: http://plnkr.co/edit/tpl:yBpEi4).
27+
-->
28+
29+
**AngularJS version:** 1.x.y
30+
<!-- Check whether this is still an issue in the most recent stable or in the snapshot AngularJS
31+
version (https://code.angularjs.org/snapshot/) -->
32+
33+
**Browser:** [all | Chrome XX | Firefox XX | Edge XX | IE XX | Safari XX | Mobile Chrome XX | Android X.X Web Browser | iOS XX Safari | iOS XX UIWebView | iOS XX WKWebView ]
34+
<!-- All browsers where this could be reproduced (and Operating System if relevant) -->
35+
36+
**Anything else:**
37+
<!-- e.g. stacktraces, related issues, suggestions how to fix -->

.github/PULL_REQUEST_TEMPLATE.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- General PR submission guidelines https://github.com/angular/angular.js/CONTRIBUTING.md#submit-pr -->
12
**What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)**
23

34

@@ -15,9 +16,9 @@
1516

1617

1718
**Please check if the PR fulfills these requirements**
18-
- [ ] The commit message follows our guidelines: https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit-message-format
19-
- [ ] Tests for the changes have been added (for bug fixes / features)
20-
- [ ] Docs have been added / updated (for bug fixes / features)
19+
- [ ] The commit message follows our [guidelines](../DEVELOPERS.md#commits)
20+
- [ ] Fix/Feature: [Docs](../DEVELOPERS.md#documentation) have been added/updated
21+
- [ ] Fix/Feature: Tests have been added; existing tests pass
2122

2223
**Other information**:
2324

0 commit comments

Comments
 (0)