Skip to content

Commit

Permalink
Revising contribution docs (#15706)
Browse files Browse the repository at this point in the history
Co-authored-by: Hisham Bin Ateya <hishamco_2007@yahoo.com>
  • Loading branch information
Piedone and hishamco committed Apr 23, 2024
1 parent ff14d13 commit ecf9f0d
Show file tree
Hide file tree
Showing 19 changed files with 227 additions and 149 deletions.
1 change: 1 addition & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<!--- Please make sure that you're familiar with our contribution guidelines before submitting a pull request: https://docs.orchardcore.net/en/latest/docs/guides/contributing/. -->
3 changes: 1 addition & 2 deletions CODE-OF-CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# Code of Conduct

This project has adopted the code of conduct defined by the [Contributor Covenant](http://contributor-covenant.org/) to clarify expected behavior in our community.
For more information see the [.NET Foundation Code of Conduct](http://www.dotnetfoundation.org/code-of-conduct).
See [Contributing to Orchard Core](https://docs.orchardcore.net/en/latest/docs/guides/contributing/) on the documentation site.
42 changes: 1 addition & 41 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,3 @@
# How to contribute

One of the easiest ways to contribute is to participate in discussions on GitHub issues. You can also contribute by submitting pull requests with code changes.

## General feedback and discussions?

Start a discussion on the [repository issue tracker](https://github.com/orchardcms/orchardcore/issues).

## Reporting security issues

Security issues should be reported privately, via email, to contact@orchardcore.net.

## Other discussions

Our team members also monitor other discussion forums:

* [GitHub Discussions](https://github.com/OrchardCMS/OrchardCore/discussions).

## Contributing code and content

We accept fixes and features! Here are some resources to help you get started on how to contribute code or new content.

* Look at the [documentation](/src/docs/).
* ["Help wanted" issues](https://github.com/orchardcms/orchardcore/labels/help%20wanted) - these issues are up for grabs. Comment on an issue if you want to create a fix.
* ["Good first issue" issues](https://github.com/orchardcms/orchardcore/labels/good%20first%20issue) - we think these are a good for newcomers.

### Identifying the scale

If you would like to contribute, first identify the scale of what you would like to contribute. If it is small (grammar/spelling or a bug fix) feel free to start working on a fix. If you are submitting a feature or substantial code contribution, please discuss it with the team and ensure it follows the roadmap. You might also read these two blogs posts on contributing code: [Open Source Contribution Etiquette](http://tirania.org/blog/archive/2010/Dec-31.html) by Miguel de Icaza and [Don't "Push" Your Pull Requests](https://www.igvita.com/2011/12/19/dont-push-your-pull-requests/) by Ilya Grigorik. All code submissions will be rigorously reviewed and tested by the team, and only those that meet an extremely high bar for both quality and design/roadmap appropriateness will be merged into the source.

### Submitting a pull request

You will need to sign a [Contributor License Agreement](https://cla.dotnetfoundation.org/) when submitting your pull request. To complete the Contributor License Agreement (CLA), you will need to follow the instructions provided by the CLA bot when you send the pull request. This needs to only be done once for any .NET Foundation OSS project.

If you don't know what a pull request is read this article: https://help.github.com/articles/using-pull-requests. Make sure the repository can build and all tests pass. Familiarize yourself with the project workflow and our coding conventions. The coding, style, and general engineering guidelines are published on the [Engineering guidelines](https://github.com/dotnet/aspnetcore/wiki/Engineering-guidelines) page.

### Feedback

Your pull request will now go through extensive checks by the subject matter experts on our team. Please be patient; we have hundreds of pull requests across all of our repositories. Update your pull request according to feedback until it is approved by one of the ASP.NET team members. After that, one of our team members may adjust the branch you merge into based on the expected release schedule.

## Code of conduct

See [CODE-OF-CONDUCT.md](./CODE-OF-CONDUCT.md)
See [Contributing to Orchard Core](https://docs.orchardcore.net/en/latest/docs/guides/contributing/) on the documentation site.
46 changes: 12 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# Orchard Core

Orchard Core is an open-source, modular, multi-tenant application framework and CMS for ASP.NET Core.

Orchard Core consists of two distinct projects:

- __Orchard Core Framework__: An application framework for building modular, multi-tenant applications on ASP.NET Core.
- __Orchard Core CMS__: A Web Content Management System (CMS) built on top of the Orchard Core Framework.

[![Join the chat at https://gitter.im/OrchardCMS/OrchardCore](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/OrchardCMS/OrchardCore?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![BSD-3-Clause License](https://img.shields.io/badge/license-BSD--3--Clause-blue.svg)](LICENSE)
[![Documentation](https://readthedocs.org/projects/orchardcore/badge/)](https://docs.orchardcore.net/)
[![Crowdin](https://badges.crowdin.net/orchard-core/localized.svg)](https://crowdin.com/project/orchard-core)
Expand All @@ -22,9 +23,7 @@ Nightly (`main`):
[![Build status](https://github.com/OrchardCMS/OrchardCore/actions/workflows/preview_ci.yml/badge.svg)](https://github.com/OrchardCMS/OrchardCore/actions?query=workflow%3A%22Preview+-+CI%22)
[![Cloudsmith](https://api-prd.cloudsmith.io/badges/version/orchardcore/preview/nuget/OrchardCore.Application.Cms.Targets/latest/x/?render=true&badge_token=gAAAAABey9hKFD_C-ZIpLvayS3HDsIjIorQluDs53KjIdlxoDz6Ntt1TzvMNJp7a_UWvQbsfN5nS7_0IbxCyqHZsjhmZP6cBkKforo-NqwrH5-E6QCrJ3D8%3D)](https://cloudsmith.io/~orchardcore/repos/preview/packages/detail/nuget/OrchardCore.Application.Cms.Targets/latest/)

## Status

### 1.8.2
## Project Status: v1.8.2

The software is production-ready, and capable of serving large mission-critical applications as well, and we're not aware of any fundamental bugs or missing features we deem crucial. Orchard Core continues to evolve, with each version bringing new improvements, and keeping up with the cutting-edge of .NET.

Expand All @@ -34,30 +33,24 @@ See the [issue milestones](https://github.com/OrchardCMS/OrchardCore/milestones)

## Getting Started and Documentation

The documentation can be accessed under <https://docs.orchardcore.net/>. See [the getting started docs](https://docs.orchardcore.net/en/latest/docs/getting-started/) on how to start using Orchard Core.

You can also run Orchard Core from Docker:

```
docker run --name orchardcms -p 8080:80 orchardproject/orchardcore-cms-linux:latest
```

Docker images and parameters can be found at <https://hub.docker.com/u/orchardproject/>. See [our Docker documentation](https://docs.orchardcore.net/en/latest/docs/topics/docker/) for more details, especially if you're new to Docker.
The documentation can be accessed under <https://docs.orchardcore.net/>. See the homepage for an overview, and [the getting started docs](https://docs.orchardcore.net/en/latest/docs/getting-started/) on how to start building apps with Orchard Core. If you'd just like to test drive Orchard Core as a user, check out [Test drive Orchard Core](https://docs.orchardcore.net/en/latest/docs/getting-started/test-drive-orchard-core/).

## Help and Support

Do you need some help with Orchard Core? Don't worry, there are ways to get help from the community:

- Did you find a bug or have a feature request? Open an issue [in the issue tracker](https://github.com/OrchardCMS/OrchardCore/issues).
- Do you have a question about how to do something with Orchard Core, or would like a second opinion on your code? Open [a discussion](https://github.com/OrchardCMS/OrchardCore/discussions).
- Do you want to chat with other community members? Check out [our Discord server](https://discord.gg/s3e2HtyPZc) and [Gitter chatroom](https://gitter.im/OrchardCMS/OrchardCore]).

## Get in Touch

- [X (Twitter)](https://twitter.com/orchardcms)
- [LinkedIn](https://www.linkedin.com/groups/13605669/)
- [Meta (Facebook)](https://www.facebook.com/OrchardCore)
- [Facebook](https://www.facebook.com/OrchardCore)
- Please report security issues privately, via email, to [contact@orchardcore.net](mailto:contact@orchardcore.net).

## Local Communities
### Local Communities

中文资源

Expand All @@ -67,34 +60,19 @@ Do you need some help with Orchard Core? Don't worry, there are ways to get help

It's great that you're thinking about contributing to Orchard Core! You'd join [our wonderful community of contributors](https://docs.orchardcore.net/en/latest/docs/community/).

First, clone the repository using the command `git clone https://github.com/OrchardCMS/OrchardCore.git` and checkout the `main` branch. Then, you have multiple options, see below. And when you're ready, head over to [our contribution guide](CONTRIBUTING.md).

### Command Line

1. Install the latest version of the .NET SDK from this page: <https://dotnet.microsoft.com/download>.
2. Navigate to `./OrchardCore/src/OrchardCore.Cms.Web`.
3. Run `dotnet run`.
4. Open the `http://localhost:5000` URL in your browser.

### Visual Studio

1. Download Visual Studio 2022 (v17.8+) from <https://www.visualstudio.com/downloads>.
2. Launch the solution by clicking on `OrchardCore.sln`. Give Visual Studio time to restore all missing Nuget packages.
3. Ensure `OrchardCore.Cms.Web` is set as the startup project. Then run the app.
Check out the docs [on contributing to Orchard Core](https://docs.orchardcore.net/en/latest/docs/guides/contributing/).

## Preview Package Feed

[![Hosted By: Cloudsmith](https://img.shields.io/badge/OSS%20hosting%20by-cloudsmith-blue?logo=cloudsmith&style=for-the-badge)](https://cloudsmith.com)

NuGet package repository hosting for the preview feed is graciously provided by [Cloudsmith](https://cloudsmith.com).
NuGet package repository hosting for the preview feed is graciously provided by [Cloudsmith](https://cloudsmith.com). Check out [the docs on using the preview package feed](https://docs.orchardcore.net/en/latest/docs/getting-started/preview-package-source/).

Cloudsmith is the only fully hosted, cloud-native, universal package management solution, that
enables your organization to create, store, and share packages in any format, to any place, with total
confidence.
Cloudsmith is the only fully hosted, cloud-native, universal package management solution, that enables your organization to create, store, and share packages in any format, to any place, with total confidence.

## Code of Conduct

See [our Code of Conduct](./CODE-OF-CONDUCT.md).
See [our Code of Conduct](https://docs.orchardcore.net/en/latest/docs/guides/contributing/#code-of-conduct).

## .NET Foundation

Expand Down
9 changes: 2 additions & 7 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,8 @@

## Supported Versions

| Version | Supported |
| ------- | ------------------ |
| 1.0 | :x: |
| 1.1 | :x: |
| 1.2 | :x: |
| 1.3 | :white_check_mark: |
We primarily support the latest version only. For serious security issues, we'll patch several older versions too.

## Reporting a Vulnerability

Send an email to sebros@microsoft.com
Please report security issues privately, via email, to [contact@orchardcore.net](mailto:contact@orchardcore.net).
10 changes: 9 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -80,12 +80,16 @@ plugins:
glob:
# Excluding the large node folder with all its MD files. We can't exclude everything apart from docs because there are links to e.g. C# files too.
- "*node_modules*"
- redirects:
redirect_maps:
'docs/topics/docs-contributions/README.md': 'docs/guides/contributing/contributing-documentation.md'

# Page tree
nav:
- About Orchard Core: README.md
- Getting started:
- Create a CMS Web application: docs/getting-started/README.md
- Test drive Orchard Core: docs/getting-started/test-drive-orchard-core.md
- Configure Preview package source: docs/getting-started/preview-package-source.md
- Recipes and Starter Themes: docs/getting-started/starter-recipes.md
- Code Generation Templates: docs/getting-started/templates/README.md
Expand All @@ -112,6 +116,11 @@ nav:
- Microsoft Entra ID (Azure AD) integration: docs/guides/microsoft-entra-id-integration/README.md
- Create a Liquid Widget: docs/guides/create-liquid-widget/README.md
- Query Content Items Based on Taxonomy: docs/guides/query-content-items-based-on-taxonomy/README.md
- Contributing:
- Contributing to Orchard Core: docs/guides/contributing/README.md
- Contributing code: docs/guides/contributing/contributing-code.md
- Contributing documentation: docs/guides/contributing/contributing-documentation.md
- Reviewing pull requests: docs/guides/contributing/reviewing-pull-requests.md
- Gulp pipeline: docs/guides/gulp-pipeline/README.md
- Key Topics:
- Manage your Content: docs/topics/content-management/README.md
Expand All @@ -125,7 +134,6 @@ nav:
# - Data: docs/topics/data/README.md
# - Configuration: docs/topics/configuration/README.md
- Workflows: docs/topics/workflows/README.md
- Contributing to the docs: docs/topics/docs-contributions/README.md
- Publishing a new release: docs/topics/publishing-releases/README.md
- Using Docker: docs/topics/docker/README.md
- Using local NuGet packages: docs/topics/local-nuget-packages/README.md
Expand Down

0 comments on commit ecf9f0d

Please sign in to comment.