Skip to content

Commit

Permalink
Add site governance process to contributing guidelines (#66)
Browse files Browse the repository at this point in the history
* Merge issue templates

* Add blog governance link to PR template

* Update Contributing

* Add process to PR template

* Apply feedback suggestions

* Update CONTRIBUTING.md

Co-authored-by: Reda Lemeden <git@redalemeden.com>

* More review comments

* Last few comments

Co-authored-by: Reda Lemeden <git@redalemeden.com>
  • Loading branch information
0xTim and kaishin authored Jun 1, 2022
1 parent 66f30ff commit 7b22ef8
Show file tree
Hide file tree
Showing 5 changed files with 100 additions and 53 deletions.
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

58 changes: 40 additions & 18 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,32 +7,54 @@ assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.
## Describe the bug

<!-- A clear and concise description of what the bug is. -->

## To Reproduce

**To Reproduce**
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.
## Expected behavior

<!-- A clear and concise description of what you expected to happen. -->

## Actual behavior

<!-- A brief description of the behavior you actually saw that differed from the expected behavior. -->

## Screenshots

<!-- If applicable, add screenshots to help explain your problem. -->

## Environment details

### Desktop (please complete the following information):

- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

### Smartphone (please complete the following information):

- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

### If possible, minimal yet complete reproducer code (or link to code)

<!-- Anything else to help us reproduce the issue -->

**Screenshots**
If applicable, add screenshots to help explain your problem.
### Swift.org version/commit hash

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
<!-- Git hash of the site if applicable -->

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
## Additional context

**Additional context**
Add any other context about the problem here.
<!-- Add any other context about the problem here. -->
22 changes: 13 additions & 9 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,23 @@
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
labels: 'enhancement'
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
## Is your feature request related to a problem? Please describe

**Describe the solution you'd like**
A clear and concise description of what you want to happen.
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
## Describe the solution you'd like

**Additional context**
Add any other context or screenshots about the feature request here.
<!-- A clear and concise description of what you want to happen. -->

## Describe alternatives you've considered

<!-- A clear and concise description of any alternative solutions or features you've considered. -->

## Additional context

<!-- Add any other context or screenshots about the feature request here. -->
10 changes: 7 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
<!--
**Note**: Please ensure that any PRs follow the Swift.org [governance process](https://www.swift.org/website-governance/). If the PR involves a blog post we have a [separate governance process](https://www.swift.org/website-governance/#blog-posts-governance) for this. You must submit your post to the Website Workgroup for approval first. Any posts that have not followed this process will automatically be rejected.
_[One line description of your change]_
-->

### Motivation:

_[Explain here the context, and why you're making that change. What is the problem you're trying to solve.]_
<!-- _[Explain here the context, and why you're making that change. What is the problem you're trying to solve.]_ -->

### Modifications:

_[Describe the modifications you've done.]_
<!-- _[Describe the modifications you've done.]_ -->

### Result:

_[After your change, what will change.]_
<!-- _[After your change, what will change.]_ -->
43 changes: 40 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,48 @@
# Contributing to Swift.org

## Overview and Governance
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:

See [website overview](http://swift.org/website) for more information about the Swift.org website goals, content governance and contribution guidelines.
The following is a set of guidelines for contributing to Swift.org on GitHub and its governance process. Use your best judgment, and feel free to propose changes to this document in a pull request.

#### Table Of Contents

* [Code of Conduct](#code-of-conduct)
* [Overview](#overview)
* [Swift Website Workgroup](#swift-website-workgroup)
* [Governance](#governance)
* [Blog Posts](#blog-posts)
* [Community Participation](#community-participation)
* [Making Pull Requests](#making-pull-requests)
* [Writing a Patch](#writing-a-patch)
* [Submitting Bug Reports](#submitting-bug-reports)

## Code of Conduct

This project and everyone participating in it is governed by the [Swift Code of Conduct](https://www.swift.org/code-of-conduct/). By participating, you are expected to uphold this code. Please report unacceptable behavior to one of the [Swift Core Team](https://swift.org/community/#community-structure) members.

## Overview

The Swift.org website has a number of goals that are defined in the [website overview](http://swift.org/website). This lays out the aims of Swift.org and should be considered when contributing.

Swift.org is guided by the [Swift Website Workgroup (SWWG)](https://www.swift.org/website-workgroup) and they are responsible for the content on the site, the design, and all technical aspects.

See `LICENSE.md` for legal information.

## Swift Website Workgroup

The [Swift Website Workgroup (SWWG)](https://www.swift.org/website-workgroup) is a steering committee comprised of members from the community. They are responsible for guiding the evolution of Swift.org, including technical decisions, design changes, and content updates.

The SWWG should be consulted before proposing any substantial changes to Swift.org, by creating a new post [on the forums](https://forums.swift.org/c/swift-website/84).

## Governance

Swift.org contributions must adhere to the website's [governance process](https://www.swift.org/website-governance/) which define how contributions will be accepted. The process covers different scenarios for contributing and how contributions will be accepted.

## Blog Posts

Blog posts are covered by a [separate governance process](https://www.swift.org/website-governance/#blog-posts-governance) which has a more extensive review process. You should [reach out to the SWWG](https://forums.swift.org/new-message?groupname=swift-website-workgroup) if you would like to contribute a post. This can encompass sharing language changes, libraries and tools and highlighting work done by the community.

Please note that pull requests for blog posts that have not been discussed with the SWWG will be rejected, with the exception of minor updates to existing posts like typos.

## Community Participation

Expand All @@ -20,7 +58,6 @@ Everyone is welcome to contribute to the Swift.org website in the following ways
* Asking or answering questions on the forums
* Reporting or triaging bugs


## Making pull requests

See `README.md` for instructions for installing a local developer environment and testing changes.
Expand Down

0 comments on commit 7b22ef8

Please sign in to comment.