Skip to content

Commit 698e5ec

Browse files
committed
Switch to GitHub issues
1 parent 4713cce commit 698e5ec

File tree

4 files changed

+21
-31
lines changed

4 files changed

+21
-31
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,17 @@ This document describes the policies and procedures for working with NHibernate.
44

55
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.
66

7-
## Check for Existing Issues Visit
7+
## Create or find a GitHub Issue
88

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.
1110

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.
1312

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.
1514

1615
## Fork and Clone from GitHub
1716

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.
1918

2019
## The Build Menu
2120

@@ -38,7 +37,7 @@ The main GitHub repository is at <https://github.com/nhibernate/nhibernate-core>
3837
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.
3938
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.
4039
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.
4241

4342
## Creating a Test Case to Verify the Issue
4443

@@ -74,9 +73,7 @@ counter-part, you should regenerate the async code. Use build-menu option H for
7473

7574
Ensure that your e-mail address and name are configured appropriately in Git.
7675

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.
8077

8178
## Implementing the Bug Fix or Improvement
8279

@@ -90,21 +87,21 @@ Please note that some tests assume a case insensitive accent sensitive database
9087

9188
## Submit a Pull Request
9289

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.
9491

9592
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.
9693

9794
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.
9895

9996
## Further Discussion
10097

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].
10299

103100
## Happy Contributing!
104101

105102
The NHibernate community values your contributions. Thank you for the time you have invested.
106103

107-
[1]: https://nhibernate.jira.com/
108-
[2]: https://nhibernate.jira.com/browse/NH-2866
104+
[1]: https://github.com/nhibernate/nhibernate-core/issues/
105+
[2]: https://github.com/nhibernate/nhibernate-core/
109106
[3]: http://www.editorconfig.org/
110107
[4]: http://groups.google.com/group/nhibernate-development

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,11 @@ There are two official NHibernate community forums:
3636
Bug Reports
3737
-----------
3838

39-
If you find any bugs, please report them using the [JIRA bug tracker][C1]. A
39+
If you find any bugs, please report them using the [GitHub issue tracker][C1]. A
4040
test-case that demonstrates the issue is usually required. Instructions on providing a test-case
4141
can be found [here][C2].
4242

43-
[C1]: http://nhibernate.jira.com
43+
[C1]: http://github.com/nhibernate/nhibernate-core/issues
4444
[C2]: http://nhibernate.info/blog/2008/10/03/the-best-way-to-solve-nhibernate-bugs-submit-good-unit-test.html
4545

4646
Licenses

ReleaseProcedure.txt

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
These are the tasks typically needed to create an official NHibernate release.
22

33

4-
* In Jira, make sure no open issues have "fix version" set to the release
4+
* In GitHub, make sure no open issues have milestone set to the release
55
that is about to happen (as these will show in the release notes).
66

7-
* Update releasenotes.txt with list of issues from Jira's Release Notes
8-
feature. See if any additions to the list of "known breaking changes"
9-
are necessary.
7+
* Update releasenotes.txt with list of issues. See if any additions to the
8+
list of "known breaking changes" are necessary.
109

1110
* Check/update version number in build-common/common.xml.
1211

@@ -24,7 +23,7 @@ These are the tasks typically needed to create an official NHibernate release.
2423

2524
* If no error or other issue requiring further changes occurred, tag the
2625
current git HEAD with a tag according to version number. Don't forget to
27-
push the tag to github.
26+
push the tag to github.
2827

2928
* Upload binary and source zip files to SourceForge. Update the "latest
3029
release".
@@ -35,17 +34,11 @@ These are the tasks typically needed to create an official NHibernate release.
3534
should already be available in the build directory, together with a batch
3635
file to push them.
3736

38-
* In Jira, mark the version as released.
37+
* In GitHub, mark the milestone as released.
3938

4039
* Post release announcement to nhusers, nhibernate-development and as
4140
project news on SourceForge.
42-
43-
41+
4442
* If this was a stable branch, merge it forward to master. Perhaps some
4543
changes need to be edited out in the merge, but this will reduce the
46-
risk of some issue being left unfixed on master.
47-
48-
49-
* Several weeks or months after the release, in Jira, we will assume all
50-
issues resolved in the release have been verified. Go ahead and close
51-
them.
44+
risk of some issue being left unfixed on master.

doc/reference/modules/preface.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@
7575
<para>
7676
If you have questions, use the
7777
<ulink url="https://groups.google.com/forum/#!forum/nhusers">NHibernate user forum</ulink>.
78-
We also provide a <ulink url="https://nhibernate.jira.com/">JIRA issue tracking system</ulink>
78+
We also provide a <ulink url="https://github.com/nhibernate/nhibernate-core/issues">GitHub issue tracking system</ulink>
7979
for bug reports and feature requests.
8080
If you are interested in the development of NHibernate, join the developer mailing list.
8181
If you are interested in translating this documentation into your language, contact us

0 commit comments

Comments
 (0)