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: CONTRIBUTING.md
+29-5Lines changed: 29 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,12 @@
1
-
##How to contribute
1
+
# How to contribute
2
2
3
-
One of the easiest ways to contribute is to participate in discussions and discuss issues.
3
+
One of the easiest ways to contribute is to participate in discussions and discuss issues. You can also contribute by submitting pull requests with code changes.
4
4
5
-
## General feedback and discussions?
6
5
6
+
## General feedback and discussions?
7
7
Please start a discussion on the [Home repo issue tracker](https://github.com/aspnet/Home/issues).
8
8
9
+
9
10
## Bugs and feature requests?
10
11
Please log a new issue in the appropriate GitHub repo. Here are some of the most common repos:
11
12
@@ -18,6 +19,7 @@ Please log a new issue in the appropriate GitHub repo. Here are some of the most
18
19
19
20
The full repo list is [here](https://github.com/aspnet).
20
21
22
+
21
23
## Other discussions
22
24
Our team members also monitor several other discussion forums:
23
25
@@ -27,7 +29,6 @@ Our team members also monitor several other discussion forums:
27
29
28
30
29
31
## Filing issues
30
-
31
32
When filing issues, please use our [bug filing templates](https://github.com/aspnet/Home/wiki/Functional-bug-template).
32
33
The best way to get your bug fixed is to be as detailed as you can be about the problem.
33
34
Providing a minimal project with steps to reproduce the problem is ideal.
@@ -42,6 +43,29 @@ Here are questions you can answer before you file a bug to make sure you're not
42
43
43
44
GitHub supports [markdown](http://github.github.com/github-flavored-markdown/), so when filing bugs make sure you check the formatting before clicking submit.
44
45
46
+
45
47
## Contributing code and content
48
+
You will need to sign a [Contributor License Agreement](https://cla.msopentech.com) before submitting your pull request. To complete the Contributor License Agreement (CLA), you will need to submit a request via the form and then electronically sign the Contributor License Agreement when you receive the email containing the link to the document. This needs to only be done once for any Microsoft Open Technologies OSS project.
49
+
50
+
Make sure you can build the code. Familiarize yourself with the project workflow and our coding conventions. If you don't know what a pull request is read this article: https://help.github.com/articles/using-pull-requests.
51
+
52
+
Before submitting a feature or substantial code contribution please discuss it with the team and ensure it follows the product roadmap. You might also read these two blogs posts on contributing code: [Open Source Contribution Etiquette](http://tirania.org/blog/archive/2010/Dec-31.html) by Miguel de Icaza and [Don't "Push" Your Pull Requests](http://www.igvita.com/2011/12/19/dont-push-your-pull-requests/) by Ilya Grigorik. Note that all code submissions will be rigorously reviewed and tested by the ASP.NET and Entity Framework teams, and only those that meet an extremely high bar for both quality and design/roadmap appropriateness will be merged into the source.
53
+
54
+
Here's a few things you should always do when making changes to the code base:
55
+
56
+
**Commit/Pull Request Format**
57
+
58
+
```
59
+
Summary of the changes (Less than 80 chars)
60
+
- Detail 1
61
+
- Detail 2
62
+
63
+
#bugnumber (in this specific format)
64
+
```
65
+
66
+
**Tests**
46
67
47
-
We are actively working to allow community code and content contributions. We can't accept code and content contributions yet, but check back soon for updates.
68
+
- Tests need to be provided for every bug/feature that is completed.
69
+
- Tests only need to be present for issues that need to be verified by QA (e.g. not tasks)
70
+
- If there is a scenario that is far too hard to test there does not need to be a test for it.
71
+
- "Too hard" is determined by the team as a whole.
0 commit comments