Browse files

Merge pull request #48 from thecodejunkie/add-github-folder

Added .github folder
  • Loading branch information...
2 parents 7b74536 + f535f3c commit a808e5e8ef73a4f430849d3559c44902fba6805b @jchannon jchannon committed Jun 6, 2017
Showing with 102 additions and 0 deletions.
  1. +63 −0 .github/
  2. +28 −0 .github/
  3. +11 −0 .github/
@@ -0,0 +1,63 @@
+# How to contribute
+First of all, thank you for wanting to contribute to Nancy! We really appreciate all the awesome support we get from our community. We want to keep it as easy as possible to contribute changes that get things working in your environment. There are a few guidelines that we need contributors to follow so that we have a chance of keeping on top of things.
+- [Making Changes](#making-changes)
+ - [Handling Updates from Upstream/Master](#handling-updates-from-upstreammaster)
+ - [Sending a Pull Request](#sending-a-pull-request)
+- [Style Guidelines](#style-guidelines)
+## Making Changes
+1. [Fork]( on GitHub
+1. Clone your fork locally
+1. Configure the upstream repo (`git remote add upstream git://`)
+1. Create a local branch (`git checkout -b myBranch`)
+1. Work on your feature
+1. Rebase if required (see below)
+1. Push the branch up to GitHub (`git push origin myBranch`)
+1. Send a Pull Request on GitHub
+You should **never** work on a clone of master, and you should **never** send a pull request from master - always from a branch. The reasons for this are detailed below.
+### Handling Updates from Upstream/Master
+While you're working away in your branch it's quite possible that your upstream master (most likely the canonical NancyFx version) may be updated. If this happens you should:
+1. [Stash]( any un-committed changes you need to
+1. `git checkout master`
+1. `git pull upstream master`
+1. `git checkout myBranch`
+1. `git rebase master myBranch`
+1. `git push origin master` - (optional) this makes sure your remote master is up to date
+This ensures that your history is "clean" i.e. you have one branch off from master followed by your changes in a straight line. Failing to do this ends up with several "messy" merges in your history, which we don't want. This is the reason why you should always work in a branch and you should never be working in, or sending pull requests from, master.
+If you're working on a long running feature then you may want to do this quite often, rather than run the risk of potential merge issues further down the line.
+### Sending a Pull Request
+While working on your feature you may well create several branches, which is fine, but before you send a pull request you should ensure that you have rebased back to a single "Feature branch". We care about your commits, and we care about your feature branch; but we don't care about how many or which branches you created while you were working on it :smile:.
+When you're ready to go you should confirm that you are up to date and rebased with upstream/master (see "Handling Updates from Upstream/Master" above), and then:
+1. `git push origin myBranch`
+1. Send a descriptive [Pull Request]( on GitHub - making sure you have selected the correct branch in the GitHub UI!
+1. Wait for @TheCodeJunkie to merge your changes in and reformat all of your code because he has StyleCop OCD :wink:.
+And remember; **A pull-request with tests is a pull-request that's likely to be pulled in.** :grin: Bonus points if you document your feature in our [wiki]( once it has been pulled in
+## Style Guidelines
+- Indent with 4 spaces, **not** tabs.
+- No underscore (`_`) prefix for member names.
+- Use `this` when accessing instance members, e.g. `this.Name = "TheCodeJunkie";`.
+- Use the `var` keyword unless the inferred type is not obvious.
+- Use the C# type aliases for types that have them, e.g. `int` instead of `Int32`, `string` instead of `String` etc.
+- Use meaningful names (no hungarian notation).
+- Wrap `if`, `else` and `using` blocks (or blocks in general, really) in curly braces, even if it's a single line.
+- Put `using` statements inside namespace.
+- Pay attention to whitespace and extra blank lines
+- Absolutely **no** regions
+> If you are a ReSharper user, you can make use of our `.DotSettings` file to ensure you cover as many of our style guidelines as possible. There may be some style guidelines which are not covered by the file, so please pay attention to the style of existing code.
@@ -0,0 +1,28 @@
+### Prerequisites
+- [ ] I have written a descriptive issue title
+- [ ] I have verified that I am running the latest version of Nancy
+- [ ] I have verified if the problem exist in both `DEBUG` and `RELEASE` mode
+- [ ] I have searched [open]( and [closed]( issues to ensure it has not already been reported
+### Description
+<!-- A description of the bug or feature -->
+### Steps to Reproduce
+<!-- List of steps, sample code, failing test or link to a project that reproduces the behavior -->
+### System Configuration
+<!-- Tell us about the environment where you are experiencing the bug -->
+- Nancy version:
+- Nancy host
+ - [ ] ASP.NET
+ - [ ] OWIN
+ - [ ] Self-Hosted
+ - [ ] Other:
+- Other Nancy packages and versions:
+- Environment (Operating system, version and so on):
+- .NET Framework version:
+- Additional information:
+<!-- Thanks for reporting the issue to Nancy! -->
@@ -0,0 +1,11 @@
+### Prerequisites
+- [ ] I have written a descriptive pull-request title
+- [ ] I have verified that there are no overlapping [pull-requests]( open
+- [ ] I have verified that I am following the Nancy [code style guidelines](
+- [ ] I have provided test coverage for my change (where applicable)
+### Description
+<!-- A description of the changes proposed in the pull-request -->
+<!-- Thanks for contributing to Nancy! -->

0 comments on commit a808e5e

Please sign in to comment.