Skip to content

Commit

Permalink
fix link & some md style suggestions (#514)
Browse files Browse the repository at this point in the history
  • Loading branch information
jennyf19 authored Aug 28, 2020
1 parent eb8af9c commit b0fe998
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 29 deletions.
19 changes: 8 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
Microsoft Identity Web for .NET welcomes new contributors. This document will guide you
through the process.
# Microsoft Identity Web for .NET welcomes new contributors.

### Contributor License agreement
This document will guide you through the process.

## Contributor License agreement

Please visit [https://cla.microsoft.com/](https://cla.microsoft.com/) and sign the Contributor License
Agreement. You only need to do that once. We can not look at your code until you've submitted this request.

### Setup, Building and Testing
## Setup, Building and Testing

Please see the [Build & Run](https://github.com/AzureAD/microsoft-identity-web/wiki/build-and-test) wiki page.

### Decide on which branch to create
## Decide on which branch to create

**Bug fixes for the current stable version need to go to 'master' branch.**

Expand All @@ -24,7 +25,7 @@ Especially do so if you plan to work on a major change in functionality. Nothin
frustrating than seeing your hard work go to waste because your vision
does not align with our goals for the SDK.

### Branch
## Branch

Okay, so you have decided on the proper branch. Create a feature branch
and start hacking:
Expand All @@ -33,8 +34,7 @@ and start hacking:
$ git checkout -b my-feature-branch
```


### Commit
## Commit

Make sure git knows your name and email address:

Expand Down Expand Up @@ -87,8 +87,6 @@ $ git rebase upstream/v0.1 # or upstream/master

It's all standard stuff, but please note that you won't be able to run integration tests locally because they connect to a KeyVault to fetch some test users and passwords. The CI will run them for you.



### Push

```
Expand All @@ -103,6 +101,5 @@ to address, apply your changes in a separate commit and push that to your
feature branch. Post a comment in the pull request afterwards; GitHub does
not send out notifications when you add commits.


[on GitHub]: https://github.com/AzureAD/microsoft-identity-web
[issue tracker]: https://github.com/AzureAD/microsoft-identity-web/issues
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Microsoft Identity Web is in preview.

## Where do I file issues

This is the correct repo to file [issues](https://github.com/AzureAD/microsoft-authentication-identity-web/issues).
This is the correct repo to file [issues](https://github.com/AzureAD/microsoft-identity-web/issues).

## Community Help and Support

Expand Down
18 changes: 8 additions & 10 deletions RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Microsoft Identity libraries are independent open source libraries that are used

The semantics are: MAJOR.MINOR.PATCH (example 1.1.5)

We will update our code distributions to use the latest PATCH semantic version number in order to make sure our customers and partners get the latest bug fixes. Downstream partner needs to pull the latest PATCH version. Most partners should try lock on the latest MINOR version number in their builds and accept any updates in the PATCH number.
We will update our code distributions to use the latest PATCH semantic version number in order to make sure our customers and partners get the latest bug fixes. Downstream partner needs to pull the latest PATCH version. Most partners should try lock on the latest MINOR version number in their builds and accept any updates in the PATCH number.

Examples:
Examples:
Using Cocapods, the following in the podfile will take the latest ADALiOS build that is > 1.1 but not 1.2.
```
pod 'ADALiOS', '~> 1.1'
Expand All @@ -31,18 +31,16 @@ version="[1.1,1.2)"
| x.x | MINOR version numbers. Incrementing these second numbers are for new feature additions that do not impact existing features or introduce regressions. They are purely additive, but may require testing to ensure nothing is impacted.,All x.x.x bug fixes will also roll up in to this number.,There is no regressions or API surface changes. Code will continue to work unless affected by a particular code fix or needs this new feature. | ADAL for iOS 1.1.0,(this added WPJ capability to ADAL, and rolled all the updates from 1.0.0 to 1.0.12) |
| x | MAJOR version numbers. This should be considered a new, supported version of Microsoft Identity SDK and begins the Azure two year support cycle anew. Major new features are introduced and API changes can occur.,This should only be used after a large amount of testing and used only if those features are needed.,We will continue to service MAJOR version numbers with bug fixes up to the two year support cycle. | ADAL for iOS 1.0,(our first official release of ADAL) |



## Serviceability

When we release a new MINOR version, the previous MINOR version is abandoned.
When we release a new MINOR version, the previous MINOR version is abandoned.

When we release a new MAJOR version, we will continue to apply bug fixes to the existing features in the previous MAJOR version for up to the 2 year support cycle for Azure.
Example: We release ADALiOS 2.0 in the future which supports unified Auth for AAD and MSA. Later, we then have a fix in Conditional Access for ADALiOS. Since that feature exists both in ADALiOS 1.1 and ADALiOS 2.0, we will fix both. It will roll up in a PATCH number for each. Customers that are still locked down on ADALiOS 1.1 will receive the benefit of this fix.
When we release a new MAJOR version, we will continue to apply bug fixes to the existing features in the previous MAJOR version for up to the 2 year support cycle for Azure.
Example: We release ADALiOS 2.0 in the future which supports unified Auth for AAD and MSA. Later, we then have a fix in Conditional Access for ADALiOS. Since that feature exists both in ADALiOS 1.1 and ADALiOS 2.0, we will fix both. It will roll up in a PATCH number for each. Customers that are still locked down on ADALiOS 1.1 will receive the benefit of this fix.

## Microsoft Identity SDKs and Azure Active Directory

Microsoft Identity SDKs major versions will maintain backwards compatibility with Azure Active Directory web services through the support period. This means that the API surface area defined in a MAJOR version will continue to work for 2 years after release.
Microsoft Identity SDKs major versions will maintain backwards compatibility with Azure Active Directory web services through the support period. This means that the API surface area defined in a MAJOR version will continue to work for 2 years after release.

We will respond to bugs quickly from our partners and customers submitted through GitHub and through our private alias ([email protected]) for security issues and update the PATCH version number. We will also submit a change summary for each PATCH number.
Occasionally, there will be security bugs or breaking bugs from our partners that will require an immediate fix and a publish of an update to all partners and customers. When this occurs, we will do an emergency roll up to a PATCH version number and update all our distribution methods to the latest.
We will respond to bugs quickly from our partners and customers submitted through GitHub and through our private alias ([email protected]) for security issues and update the PATCH version number. We will also submit a change summary for each PATCH number.
Occasionally, there will be security bugs or breaking bugs from our partners that will require an immediate fix and a publish of an update to all partners and customers. When this occurs, we will do an emergency roll up to a PATCH version number and update all our distribution methods to the latest.
14 changes: 7 additions & 7 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ You should receive a response within 24 hours. If for some reason you do not, pl

Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:

* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
* Full paths of source file(s) related to the manifestation of the issue
* The location of the affected source code (tag/branch/commit or direct URL)
* Any special configuration required to reproduce the issue
* Step-by-step instructions to reproduce the issue
* Proof-of-concept or exploit code (if possible)
* Impact of the issue, including how an attacker might exploit the issue
* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
* Full paths of source file(s) related to the manifestation of the issue
* The location of the affected source code (tag/branch/commit or direct URL)
* Any special configuration required to reproduce the issue
* Step-by-step instructions to reproduce the issue
* Proof-of-concept or exploit code (if possible)
* Impact of the issue, including how an attacker might exploit the issue

This information will help us triage your report more quickly.

Expand Down

0 comments on commit b0fe998

Please sign in to comment.