From 2cee86a1e0ead1328dd509e75d5f2df327e64b73 Mon Sep 17 00:00:00 2001 From: arturo Date: Fri, 22 Mar 2019 10:59:31 +0100 Subject: [PATCH] [Docs] - openframeworks/openframeworks - openframeworks/CONTRIBUTING.md - minor tweaks [grammar, etc al] (#5846) --- CONTRIBUTING.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7fe65c84734..a7bd5975935 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,7 +24,7 @@ We love hearing about bugs! It's how we get them fixed. - Make sure you give it a good title! A good title explains the core of the problem in about 5-10 words. (It's sometimes easier to write the title after you've written the description.) - Examples of bad titles: _problem with ofRectangle_ or _can't set color_ - - Examples of good titles: _ofRectangle crashes if width is 0_ or _ofSetColor doesn't work with ofPath objects_. + - Examples of good titles: _ofRectangle crashes if the width is 0_ or _ofSetColor doesn't work with ofPath objects_. - In the description, include the following details: 0. **relevant system information** such as which openFrameworks version, operating system, and IDE you are using, 1. what you were doing when you noticed the bug, @@ -43,7 +43,7 @@ We're simply a busy group of people, but you will hear back eventually. At the moment we don't have a formal roadmap for the project, rather we are a community of people who each contributes to sections that we feel are important for the project. Feature requests are therefore mostly a way of us discussing/feeling out together where we'd like the project to go. -This can sometimes involve a lot of discussion, as everyone uses openFrameworks differently. +This can sometimes involves a lot of discussion, as everyone uses openFrameworks differently. Feature requests are created as Github Issues, just like bugs. Feature requests are also where code that you or anyone else would like to include in a future pull request is **discussed before being implemented!** @@ -53,8 +53,8 @@ But please make sure it's been discussed as a feature request _before_ you submi Before opening a feature request, please search the issue tracker and confirm an existing request touching the same topic doesn't already exist. - We are generally a friendly and open collection of people, but communication over the internet can be difficult, so please don't treat a lot of discussion as a negative point against your feature request. -Usually a lot of discussion just means that we haven't thought about what you're requesting before, which is a good thing! -- On the other hand, we are also busy people, often professionally involved in making large scale projects ourselves, using openFrameworks. +Usually, a lot of discussions just means that we haven't thought about what you're requesting before, which is a good thing! +- On the other hand, we are also busy people, often professionally involved in making large-scale projects ourselves, using openFrameworks. If you feel like no-one is paying attention to your feature request, just be patient, it will be considered eventually. - And finally, a small reality check: please don't expect that a general agreement in the discussion that a feature request is a good idea means it will get made immediately! As with most open source projects, the fastest way to get a feature made is to make it yourself, or if you are not a programmer, make friends with someone who is, introduce them to openFrameworks, and ask them to make it for you. @@ -92,4 +92,3 @@ This granularity makes the code easier to deal with in cases where some things h - Reference any issues or bugs in the [oF issue tracker](github.com/openframeworks/openFrameworks/issues) that are relevant to your pull request using `#issue number` notation, eg to reference issue __1234__ write `#1234`. - Mention if the code has been tested and on what platform. - Your pull request will be evaluated via the [Pull Request Review Procedure](https://github.com/openframeworks/openFrameworks/wiki/Pull-Request-Review-Procedure) -