diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9c9b026289f..5926d9a248f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,18 +4,17 @@ This document describes the policies and procedures for working with NHibernate. 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. -## Check for Existing Issues Visit +## Create or find a GitHub Issue -[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. -## Create a JIRA Issue +GitHub is used to generate the release notes and serves as a central point of reference for all changes that have occurred to NHibernate. -JIRA is used to generate the release notes and serves as a central point of reference for all changes that have occurred to NHibernate. +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. -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 +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. ## Fork and Clone from GitHub -The main GitHub repository is at . 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. +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. ## The Build Menu @@ -38,7 +37,7 @@ The main GitHub repository is at 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. 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. 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. -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. +5. Before using the database for unit tests from Visual Studio, you'll need to create an empty database that matches your connection string. ## Creating a Test Case to Verify the Issue @@ -74,9 +73,7 @@ counter-part, you should regenerate the async code. Use build-menu option H for Ensure that your e-mail address and name are configured appropriately in Git. -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. - -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*.) +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. ## Implementing the Bug Fix or Improvement @@ -90,7 +87,7 @@ Please note that some tests assume a case insensitive accent sensitive database ## Submit a Pull Request -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. +If you are fixing an existing issue, please make sure to include this issue number in your GitHub pull request. 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. @@ -98,13 +95,13 @@ After submitting your pull request, come back later to check the outcome of auto ## Further Discussion -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]. +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]. ## Happy Contributing! The NHibernate community values your contributions. Thank you for the time you have invested. - [1]: https://nhibernate.jira.com/ - [2]: https://nhibernate.jira.com/browse/NH-2866 + [1]: https://github.com/nhibernate/nhibernate-core/issues/ + [2]: https://github.com/nhibernate/nhibernate-core/ [3]: http://www.editorconfig.org/ [4]: http://groups.google.com/group/nhibernate-development diff --git a/README.md b/README.md index 68d7e1fb170..459fbe3dc11 100644 --- a/README.md +++ b/README.md @@ -36,11 +36,11 @@ There are two official NHibernate community forums: Bug Reports ----------- -If you find any bugs, please report them using the [JIRA bug tracker][C1]. A +If you find any bugs, please report them using the [GitHub issue tracker][C1]. A test-case that demonstrates the issue is usually required. Instructions on providing a test-case can be found [here][C2]. -[C1]: http://nhibernate.jira.com +[C1]: http://github.com/nhibernate/nhibernate-core/issues [C2]: http://nhibernate.info/blog/2008/10/03/the-best-way-to-solve-nhibernate-bugs-submit-good-unit-test.html Licenses diff --git a/ReleaseProcedure.txt b/ReleaseProcedure.txt index 095e7bec519..0139bd44a5c 100644 --- a/ReleaseProcedure.txt +++ b/ReleaseProcedure.txt @@ -1,12 +1,11 @@ These are the tasks typically needed to create an official NHibernate release. - * In Jira, make sure no open issues have "fix version" set to the release + * In GitHub, make sure no open issues have milestone set to the release that is about to happen (as these will show in the release notes). - * Update releasenotes.txt with list of issues from Jira's Release Notes - feature. See if any additions to the list of "known breaking changes" - are necessary. + * Update releasenotes.txt with list of issues. See if any additions to the + list of "known breaking changes" are necessary. * Check/update version number in build-common/common.xml. @@ -24,7 +23,7 @@ These are the tasks typically needed to create an official NHibernate release. * If no error or other issue requiring further changes occurred, tag the current git HEAD with a tag according to version number. Don't forget to - push the tag to github. + push the tag to github. * Upload binary and source zip files to SourceForge. Update the "latest release". @@ -35,17 +34,11 @@ These are the tasks typically needed to create an official NHibernate release. should already be available in the build directory, together with a batch file to push them. - * In Jira, mark the version as released. + * In GitHub, mark the milestone as released. * Post release announcement to nhusers, nhibernate-development and as project news on SourceForge. - - + * If this was a stable branch, merge it forward to master. Perhaps some changes need to be edited out in the merge, but this will reduce the - risk of some issue being left unfixed on master. - - - * Several weeks or months after the release, in Jira, we will assume all - issues resolved in the release have been verified. Go ahead and close - them. + risk of some issue being left unfixed on master. \ No newline at end of file diff --git a/doc/reference/modules/preface.xml b/doc/reference/modules/preface.xml index 6ad6127d780..cfea77ff0b6 100644 --- a/doc/reference/modules/preface.xml +++ b/doc/reference/modules/preface.xml @@ -75,7 +75,7 @@ If you have questions, use the NHibernate user forum. - We also provide a JIRA issue tracking system + We also provide a GitHub issue tracking system for bug reports and feature requests. If you are interested in the development of NHibernate, join the developer mailing list. If you are interested in translating this documentation into your language, contact us