From 7b22ef8b3bc6860c51b331dec1215cf7f2640c47 Mon Sep 17 00:00:00 2001 From: Tim Condon <0xTim@users.noreply.github.com> Date: Wed, 1 Jun 2022 11:06:00 +0100 Subject: [PATCH] Add site governance process to contributing guidelines (#66) * 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 * More review comments * Last few comments Co-authored-by: Reda Lemeden --- .github/ISSUE_TEMPLATE.md | 20 -------- .github/ISSUE_TEMPLATE/bug_report.md | 58 ++++++++++++++++------- .github/ISSUE_TEMPLATE/feature_request.md | 22 +++++---- .github/PULL_REQUEST_TEMPLATE.md | 10 ++-- CONTRIBUTING.md | 43 +++++++++++++++-- 5 files changed, 100 insertions(+), 53 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 1d1137fa9..000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,20 +0,0 @@ -### Expected behavior -_[what you expected to happen]_ - -### Actual behavior -_[what actually happened]_ - -### Steps to reproduce - -1. ... -2. ... - -### If possible, minimal yet complete reproducer code (or URL to code) - -_[anything to help us reproducing the issue]_ - -### Swift.org version/commit hash - -_[the tag/commit hash]_ - -### Swift & OS version (output of `swift --version && uname -a`) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index f3d5c415e..27c807b49 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,32 +7,54 @@ assignees: '' --- -**Describe the bug** -A clear and concise description of what the bug is. +## Describe the bug + + + +## 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 + + + +## Actual behavior + + + +## Screenshots + + + +## 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) + + -**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] + -**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. + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bbcbbe7d6..05b37fb50 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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. + -**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. + + +## Describe alternatives you've considered + + + +## Additional context + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ab90c7b9a..84f94edff 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,13 +1,17 @@ + ### Motivation: -_[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.]_ + ### Result: -_[After your change, what will change.]_ + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 953629974..76ade0ff7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 @@ -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.