Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add reference to other .NET OSS projects and add relationship with Mono #5

Merged
merged 3 commits into from
Nov 2, 2014
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,21 +21,24 @@ let everybody know that you want to work on it.
is none, create one.
2. Create a fork in GitHub
3. Create a branch off the `master` branch. Name it something that that makes
sense, such as `issue-123`. This makes it easy for you to figure out what
the branch is used for.
sense, such as `issue-123` or `githubhandle-issue`. This makes it easy for everyone to figure out what
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most people use slashes for that, such as immol/topic, but I don't think it is material.

the branch is used for. It also makes it easier to isolate your change from incoming changes from the origin.
4. Commit your changes and push your changes to GitHub
5. Create a pull request against the origin's `master` branch

## DOs and DON'Ts

* **DO** follow our coding style (see below)
* **DON'T** surprise us with big pull requests. Instead, file an issue and start
a discussion so we can agree on a direction before you invest a large amount
of time.
* **DO** include tests when adding new features. When fixing bugs, start with
adding a test that highlights how the current behavior is broken.
* **DO** keep the discussions focused. When a new or related topic comes up
it's often better to create new issue than to side track the discussion.
* **DO** blog and tweet (or whatever) about your contributions, frequently!
* **DON'T** surprise us with big pull requests. Instead, file an issue and start
a discussion so we can agree on a direction before you invest a large amount
of time.
* **DON'T** commit code that you didn't write. If you find MIT or Apache 2 licensed code that you think is a good fit to add to .NET Core, file an issue and start a discussion before proceeding.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The last one is a good one.


## C# Coding Style

Expand Down
35 changes: 18 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,37 +15,38 @@ See specific projects to understand the license used.

## .NET Foundation

All projects have been contributed to the [.NET Foundation](http://www.dotnetfoundation.org/projects).
There are two main .NET Foundation projects for Microsoft open source projects:
All projects have been contributed to the [.NET Foundation](http://www.dotnetfoundation.org/projects). There are two main .NET Foundation projects for Microsoft open source projects:
[ASP.NET Core 5 project](http://www.dotnetfoundation.org/prjaspnetvnext.aspx)
and the [.NET Core 5 project](http://www.dotnetfoundation.org/prjaspnetvnext.aspx).

## How to Engage, Contribute and Provide Feedback

All projects (gladly) accept PRs and other contributions. To contribute to
ASP.NET 5 or EntityFramework, see [the ASP.NET Contributing Guide](https://github.com/aspnet/Home/blob/master/CONTRIBUTING.md).
To contribute to .NET Core 5, see the [.NET Core Contributing Guide](CONTRIBUTING.md).
ASP.NET 5 or EntityFramework, see [the ASP.NET Contributing Guide](https://github.com/aspnet/Home/blob/master/CONTRIBUTING.md). To contribute to .NET Core 5, see the [.NET Core Contributing Guide](CONTRIBUTING.md).

You are also encouraged to start a discussion by filing an issue or creating a
gist. See the contributing guides for more details. You can discuss .NET OSS
more generally in the [.NET Foundation forums](http://www.dotnetfoundation.org/).

## Finding .NET Projects from Microsoft on GitHub
## Finding .NET Open Source Projects

There are several open source .NET projects from Microsoft on GitHub, including
[ASP.NET 5](https://github.com/aspnet/home), [EntityFramework](https://github.com/aspnet/EntityFramework)
and [.NET Core 5](https://github.com/Microsoft/dotnet-corefx). Each one of these
projects maps to one or more [.NET NuGet package](http://blogs.msdn.com/b/dotnet/p/nugetpackages.aspx)
that are published on [NuGet.org](http://nuget.org/). They are also many great
open source .NET community projects on GitHub and Codeplex, including the
[Mono Project](https://github.com/mono/).
[ASP.NET 5](https://github.com/aspnet/home), [EntityFramework](https://github.com/aspnet/EntityFramework)and [.NET Core 5](https://github.com/Microsoft/dotnet-corefx). Each one of these projects maps to one or more [.NET NuGet package](http://blogs.msdn.com/b/dotnet/p/nugetpackages.aspx) that are published on [NuGet.org](http://nuget.org/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing space before and in EntityFrameworkand


There are other .NET projects from Microsoft on CodePlex, such as [.NET Compiler Platform ("Roslyn")](https://roslyn.codeplex.com).

They are also many great open source .NET community projects, including the [Mono Project](https://github.com/mono/) and [JSON.NET](http://json.codeplex.com/).

## Understanding the Relationship between .NET Core and Mono

Mono is an important part of the .NET ecosystem, particularly for client scenarios (ex: Xamarin). We will look for ways to collaborate with Mono developers and encourage them to take our code to improve Mono. We will also look for opportunities to improve .NET Core with MIT-licensed Mono code.

An important collaboration opportunity is making .NET Core NuGet packages (produced from this code) work on Mono. The SIMD NuGet package is a perfect example.


## Learning about ASP.NET Core 5 and .NET Core 5

ASP.NET Core 5 is a new cross-platform version of ASP.NET that is designed for
the cloud. It uses the .NET Core 5 runtime and framework, which runs on Windows,
Linux and Mac. [ASP.NET Core 5](https://github.com/aspnet/home) and
[.NET Core 5 libraries](https://github.com/Microsoft/dotnet-corefx) are open
source on GitHub. At present, only a few libraries are available on GitHub. The
rest of the libraries, including the base runtime, will be added in the coming
months.
the cloud, and runs on Windows, Linux and Mac. It uses the .NET Core 5 runtime and framework for running on Windows. It currently uses Mono for Linux and Mac support but will move to .NET Core 5 for those platforms when they are supported.

[ASP.NET Core 5](https://github.com/aspnet/home) and [.NET Core 5 libraries](https://github.com/Microsoft/dotnet-corefx) are open source on GitHub. At present, only a few libraries are available on GitHub. The rest of the libraries, including the base runtime, will be added in the coming months.