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
+11-14Lines changed: 11 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -4,18 +4,17 @@ This document describes the policies and procedures for working with NHibernate.
4
4
5
5
For the least friction, please follow the steps in the order presented, being careful not to miss any. There are many details in this document that will help your contribution go as smoothly as possible. Please read it thoroughly.
6
6
7
-
## Check for Existing Issues Visit
7
+
## Create or find a GitHub Issue
8
8
9
-
[https://nhibernate.jira.com][1] and search for your issue. If you see it, voting for it is a good way to increase the visibility of the issue.
10
-
## Create a JIRA Issue
9
+
GitHub is used to generate the release notes and serves as a central point of reference for all changes that have occurred to NHibernate.
11
10
12
-
JIRA is used to generate the release notes and serves as a central point of reference for all changes that have occurred to NHibernate.
11
+
Visit [https://github.com/nhibernate/nhibernate-core/issues][1] and search for your issue. If you see it, giving it a like is a good way to increase the visibility of the issue.
13
12
14
-
Before creating an issue, please do your best to verify the existence of the problem. This reduces noise in the issue tracker and helps conserve the resources of the team for more useful tasks. Note the issue number for future steps. Ex. NH-2318
13
+
Before creating an issue, please do your best to verify the existence of the problem. This reduces noise in the issue tracker and helps conserve the resources of the team for more useful tasks. Note the issue number for future steps.
15
14
16
15
## Fork and Clone from GitHub
17
16
18
-
The main GitHub repository is at <https://github.com/nhibernate/nhibernate-core>. If you plan to contribute your test case or improvement back to NHibernate, you should visit that page and fork the repository so you can commit your own changes and then submit a pull request.
17
+
The main GitHub repository is at [https://github.com/nhibernate/nhibernate-core][2]. If you plan to contribute your test case or improvement back to NHibernate, you should visit that page and fork the repository so you can commit your own changes and then submit a pull request.
19
18
20
19
## The Build Menu
21
20
@@ -38,7 +37,7 @@ The main GitHub repository is at <https://github.com/nhibernate/nhibernate-core>
38
37
2. Run the build menu and select option B to create a new test configuration. Notepad will pop up and you should edit the connection string information, saving it when you're done. These configurations will appear in the "available-test-configurations" folder.
39
38
3. Run the build menu and select option C to activate the test configuration you created. The appropriate configuration will be copied to the "current-test-configuration" folder.
40
39
4. (Optional) Run all the tests with option D and hopefully you will see no failing tests. The build may fail on certain databases; please ask on the mailing list if you are having trouble.
41
-
5. Before using the database for unit tests from Visual Studio, you'll need to create an empty database that matches your connection string.[NH-2866][2] will make this easier, but for now you just have to drop/create the database specified in your connection string yourself.
40
+
5. Before using the database for unit tests from Visual Studio, you'll need to create an empty database that matches your connection string.
42
41
43
42
## Creating a Test Case to Verify the Issue
44
43
@@ -74,9 +73,7 @@ counter-part, you should regenerate the async code. Use build-menu option H for
74
73
75
74
Ensure that your e-mail address and name are configured appropriately in Git.
76
75
77
-
Create a feature branch so it's easy to keep it separate from other improvements. Having a pull request accepted might involve further commits based on community feedback, so having the feature branch provides a tidy place to work from. Using the issue number as the branch name is good practice.
78
-
79
-
When you commit, please include the issue number in your commit message. This will allow the JIRA issue tracker to automatically link your commits to the issue. By example: *NH-1234 - test case for blah trouble*. Make sure you do not put any non whitespace character adjacent to the issue number, as this would prevent JIRA to match it. (Avoid *NH-1234: test case for blah trouble*.)
76
+
Create a feature branch so it's easy to keep it separate from other improvements. Having a pull request accepted might involve further commits based on community feedback, so having the feature branch provides a tidy place to work from. Using the issue number as the branch name is good practice.
80
77
81
78
## Implementing the Bug Fix or Improvement
82
79
@@ -90,21 +87,21 @@ Please note that some tests assume a case insensitive accent sensitive database
90
87
91
88
## Submit a Pull Request
92
89
93
-
Be sure to link to the JIRA issue in your GitHub pull request. Also, go back to your JIRA issue and link to the pull request.
90
+
If you are fixing an existing issue, please make sure to include this issue number in your GitHub pull request.
94
91
95
92
We use tabs for code indentation, not spaces. As this is not the default in Visual Studio, you will need to reconfigure Visual Studio to indent with tabs whenever you work on the NHibernate codebase. To make this easier, NHibernate has an [editorconfig][3] configuration file to switch Visual Studio automatically between tabs and spaces mode. It is recommended you install editorconfig from the Visual Studio Extension Manager.
96
93
97
94
After submitting your pull request, come back later to check the outcome of automated builds. If some have failed, they will be listed in your pull request with a link to the corresponding TeamCity build. Find out in the build which tests are newly failing, and take appropriate action. Some of those builds have many known failing tests, which does not trigger a build failure. A *Comparison.txt* file in build Artifacts may help finding which failing tests are not known failing tests and must be addressed.
98
95
99
96
## Further Discussion
100
97
101
-
The NHibernate team monitors JIRA and GitHub regularly, so your request will be noticed. If you want to discuss it further, you are welcome to post to the [nhibernate-development mailing list][4].
98
+
The NHibernate team monitors GitHub regularly, so your request will be noticed. If you want to discuss it further, you are welcome to post to the [nhibernate-development mailing list][4].
102
99
103
100
## Happy Contributing!
104
101
105
102
The NHibernate community values your contributions. Thank you for the time you have invested.
0 commit comments