Contribute to FluentSecurity
Missing a feature or just want to help out? To maximize the chances of getting your pull-request accepted, please take a moment to read this guide on how to contribute to FluentSecurity.
1) Fork the project
Fork the project and add an upstream for (https://github.com/kristofferahl/FluentSecurity.git).
You can find more info about forking on github's help pages.
2) Create a branch
Feature branch - Created from the develop branch
git checkout -b feature-abc develop
Hotfix branch - Created from the master branch
git checkout -b fix-abc master
3) Run setup script
To make sure you have a "working" copy of the project you should start by running
build-local.cmd located in the root directory of the repository. This will create the
SharedAssemblyInfo.cs and run all unit tests. If all goes well you are now set up to work.
4) Setup tab settings in Visual Studio
In FluentSecurity we use tabs instead of spaces. To make sure you have the correct setup, choose one of the following methods:
4.a) Using EditorConfig
EditorConfig helps you manage the tab/spaces settings for Visual Studio. Download and install the Visual Studio plugin and you're done (http://visualstudiogallery.msdn.microsoft.com/c8bccfe2-650c-4b42-bc5c-845e21f96328). Read more about EditorConfig at http://editorconfig.org/.
4.b) Manual configuration
To make sure Visual Studio is set to use tabs instead of spaces you navigate to "Tools > Options > Text Editor > All Languages > Tabs". Set "Tab size" and "Indent size" to 4. "Keep tabs" should be checked.
Work, work, work...
- Keep your code changes small and focused. Small commits are preferred!
- Write tests!
- Write proper commit messages! Commit messages should be helpful to others.
- Do your work in the open. Share your ideas with the community as early as possible.
Before sending the pull request
Pull changes from upstream (the official repository) to your
git checkout develop git pull upstream/develop
Rebase your branch from develop.
git checkout feature-abc git rebase develop
Finally, merge the feature branch into
git checkout develop git merge --no-ff feature-abc
You're now ready to do a pull request. Make sure the pull-request has the correct destination branch. If it is a feature branch the destination should be
develop and if it is a hotfix branch you should target the
master branch. Read more about pull-requests here.