Skip to content

Commit

Permalink
Clean up CONTRIBUTING.md after rename
Browse files Browse the repository at this point in the history
- Remove CONTRIBUTORS.txt, it's not updated so no longer relevant.
  • Loading branch information
AndersAbel committed Jan 12, 2018
1 parent bf75514 commit 1ebe0f3
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 43 deletions.
31 changes: 4 additions & 27 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Contributing
===========

Sustainsys.Saml2 is maintained by and have mostly been developed by Sustainsys in Stockholm,
Sweden. The library's source code is hosted on [github](https://github.com/SustainsysIT/Saml2).
Sweden. The library's source code is hosted on [github](https://github.com/Sustainsys/Saml2).

When doing work on protocol features, it is recommended to consult the
[official SAML specifications](https://wiki.oasis-open.org/security/FrontPage#SAMLV2.0Standard).
Expand All @@ -24,11 +24,6 @@ Sustainsys Authentication services uses semantic versioning as defined on http:/
MINOR version when you add functionality in a backwards-compatible manner, and
PATCH version when you make backwards-compatible bug fixes.

Additionally *even* PATCH numbers are releases that corresponds to a tag in the
repository. *Odd* PATCH numbers are development versions. This means that the
current code in the repository will always have an *odd* PATCH number to denote that
it is a development version.

## Coding Conventions
The coding conventions follow the classic .NET style of coding, with the following
styles:
Expand All @@ -46,40 +41,22 @@ not a 30-inch development monster-monitor in vertical orientation).
* The code is formatted to (mostly) fit in 80 columns.

## Unit Tests
The core Sustainsys.Saml2 library has been developed using TDD (Test Driven Development). All
The Sustainsys.Saml2 library has been developed using TDD (Test Driven Development). All
functionality is covered by tests, and it will remain that way. Pull requests will only be
merged if they contain tests covering the added functionality. Parts of the code that aren't
practically possible to test because of tight integration with the web server (see e.g.
`CommandResult.ApplyPrincipal`) are excluded from this rule and should be marked with a
`[ExcludeFromCodeCoverage]` attribute. The code coverage report is at 100.00% coverage and
should remain so.

## Integration Tests
There are also some integration tests that run through the sample applications and make
sure that they work. To run the integration tests:
* Make sure that you have Google Chrome installed.
* Open the main solution.
* Set multiple startup projects: Sustainsys.Saml2.StubIdp, SampleApplication, SampleMvcApplication
and SampleOwinApplication.
* Debug the solution.
* Open Sustainsys.Saml2.IntegrationTests in a separate Visual Studio Instance.
* Run all tests in the IntegrationTests solution.

## Continous integration / build server
Sustainsys.Saml2 contains configuration for [AppVeyor CI](|https://ci.appveyor.com/).

You may set up a free build of all branches in your GitHub fork by signing up to AppVeyor
(preferably with your GitHub account) and then creating a new project for your GitHub fork.
## Continuos integration / build server
All pull requests are built on AppVeyor and code coverage is checked.

## Branching
To make a clean pull request, it is important to follow some git best practices. Nancy
has an [excellent guide](https://github.com/NancyFx/Nancy/wiki/Git-Workflow) that outlines
the steps required.

## Contributors File
There is a [contributors list](../CONTRIBUTORS.txt) with a list of all contributors to the library. If
you want to be listed there, please add yourself as part of the pull request.

## Licensing
The library is licensed under LGPL and by submitting code it is accepted that the submitted
code will be released under the same license. Third party code may only be added to the library
Expand Down
16 changes: 0 additions & 16 deletions CONTRIBUTORS.txt

This file was deleted.

0 comments on commit 1ebe0f3

Please sign in to comment.