From 216d1c7692a532967dbe3d6d72d3e072b1b0fbec Mon Sep 17 00:00:00 2001 From: Ethan Crawford Date: Fri, 8 Oct 2021 22:43:14 +0800 Subject: [PATCH] Docs - fix typo and broken links in contributing docs [ci skip] --- CONTRIBUTING.md | 8 ++++---- TYPES-OF-CONTRIBUTIONS.md | 6 +++--- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a4252226d6..784be32f07 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ Hello! If you are interested in contributing to Sonic Pi in some way, fantastic. Everyone is welcome to help! -Are you wondering about the different ways you might be able to contribute? See [TYPES-OF-CONTRIBUTIONS.md](https://github.com/sonic-pi-net/sonic-pi/TYPES-OF-CONTRIBUTIONS.md). +Are you wondering about the different ways you might be able to contribute? See [TYPES-OF-CONTRIBUTIONS.md](TYPES-OF-CONTRIBUTIONS.md). Do you want to know about all the new features that we'd love to see included in Sonic Pi? See [the Sonic Pi features project board](https://github.com/orgs/sonic-pi-net/projects/1). @@ -10,7 +10,7 @@ Do you want to know about all the new features that we'd love to see included in There are several ways that you can learn more about the technical design of the Sonic Pi source code. - You can read brief outlines of the source code structure, and see a diagram of the major components, available from the 'Development' section of the sidebar on the [Sonic Pi wiki](https://github.com/sonic-pi-net/sonic-pi/wiki). _**Note: these are all out-of-date to varying degrees and we are in the process of updating them - so for any serious use, feel free to talk with us directly in the mean-time.**_ - You can study the source code itself at our official [Sonic Pi GitHub repository](https://github.com/sonic-pi-net/sonic-pi) -- You can ask the core development team or wider Sonic Pi community questions at any of the places we gather as a [community](https://github.com/sonic-pi-net/sonic-pi/COMMUNITY.md) +- You can ask the core development team or wider Sonic Pi community questions at any of the places we gather as a [community](COMMUNITY.md) ## Project and development process guidelines There are several guidelines that we value when planning the format of new work. We encourage community contributors to keep these in mind also when thinking about contributing to Sonic Pi. They are: @@ -27,11 +27,11 @@ Also, regarding the Sonic Pi development process: - We merge code into `main` branch for stable releases only, and all work in progress we merge into `dev` branch - We want code intended to be merged into the `main` or `dev` branches to be passing all tests where possible - We prefer an issue ticket to be raised as soon as possible when a new bug is discovered (ideally within 48 hours) -- When someone intends to start work on an issue or new feature, they check the [Issues page](https://github.com/sonic-pi-net/sonic-pi/issues) or [the Sonic Pi features project board](https://github.com/orgs/sonic-pi-net/projects/1) first. If the issue or feature is not already being worked on, the person who intends to start it mentions this publicly somewhere. (They can do this by updating the issue ticket, or mentioning it in any of the places we gather as a [community](https://github.com/sonic-pi-net/sonic-pi/COMMUNITY.md), in order to minimise the possibility of duplicated work. +- When someone intends to start work on an issue or new feature, they check the [Issues page](https://github.com/sonic-pi-net/sonic-pi/issues) or [the Sonic Pi features project board](https://github.com/orgs/sonic-pi-net/projects/1) first. If the issue or feature is not already being worked on, the person who intends to start it mentions this publicly somewhere, in order to minimise the possibility of duplicated work. (They can do this by updating the issue ticket, or mentioning it in any of the places we gather as a [community](COMMUNITY.md)). ## Ideal process for contributing with code 1. Familiarise yourself with the part(s) of the code that you wish to contribute towards if necessary. We're always happy to answer questions about the Sonic Pi code! -2. For complex or large code changes, it's worth initially discussing the potential solutions with the core team and other Sonic Pi contributors - either by opening an issue and labelling it as a feature request, or again by chatting with us at any of the places we gather as a [community](https://github.com/sonic-pi-net/sonic-pi/COMMUNITY.md). +2. For complex or large code changes, it's worth initially discussing the potential solutions with the core team and other Sonic Pi contributors - either by opening an issue and labelling it as a feature request, or again by chatting with us at any of the places we gather as a [community](COMMUNITY.md). 3. Fork a copy of the Sonic Pi repository to your personal GitHub account. 4. Clone your fork to your local machine. 5. Make changes to your local clone of Sonic Pi. diff --git a/TYPES-OF-CONTRIBUTIONS.md b/TYPES-OF-CONTRIBUTIONS.md index 011b80fcd5..0391a93b0e 100644 --- a/TYPES-OF-CONTRIBUTIONS.md +++ b/TYPES-OF-CONTRIBUTIONS.md @@ -4,7 +4,7 @@ Hello! Are you interested in contributing to Sonic Pi, but not sure where to sta Here's a few ways you can help: ## Share your Sonic Pi experiences -- Sharing your Sonic Pi experiences with people is a great way to raise awareness of Sonic Pi. Giving talks, performances, tutorials or workshops, sharing resources and teaching materials, or even just posting a simple message on social media about it (on Twitter we're `@Sonic_Pi`) are all ways you can spread the word. For all the different ways people can connect as a community around Sonic Pi, see [COMMUNITY.md](https://github.com/sonic-pi-net/sonic-pi/blob/main/COMMUNITY.md) +- Sharing your Sonic Pi experiences with people is a great way to raise awareness of Sonic Pi. Giving talks, performances, tutorials or workshops, sharing resources and teaching materials, or even just posting a simple message on social media about it (on Twitter we're `@Sonic_Pi`) are all ways you can spread the word. For all the different ways people can connect as a community around Sonic Pi, see [COMMUNITY.md](COMMUNITY.md) ## Help with issues and pull requests on GitHub - Proof-reading pull requests. If a pull request contains plain text besides code, then spelling and grammar checks are always helpful. The default language is British English (en-GB). @@ -29,7 +29,7 @@ It's a wonderful way to introduce school kids in your country to Sonic Pi and educators will appreciate it when we make it easier for their class. The tutorial is fairly long, but the graphical user interface is quickly translated and a good place to start. -For details, see [TRANSLATION.md](https://github.com/sonic-pi-net/sonic-pi/blob/main/TRANSLATION.md) +For details, see [TRANSLATION.md](TRANSLATION.md) ## Send us some changes for Sonic Pi in a Pull Request We're always interested in receiving fixes, new features and improvements for Sonic Pi - even more so in areas that the core team has been unable to focus on! @@ -37,4 +37,4 @@ We're always interested in receiving fixes, new features and improvements for So If you don't have a specific bug-fix, new feature, or enhancement already in mind, you can always browse the [open issues](https://github.com/sonic-pi-net/sonic-pi/issues) or [the Sonic Pi features project board](https://github.com/orgs/sonic-pi-net/projects/1) on GitHub. There's probably an issue you can help to fix, or feature request you can help build. -For guidelines to keep in mind while you're preparing your contribution, see [CONTRIBUTING.md](https://github.com/sonic-pi-net/sonic-pi/blob/main/CONTRIBUTING.md) +For guidelines to keep in mind while you're preparing your contribution, see [CONTRIBUTING.md](CONTRIBUTING.md)