From 513216cc6ea9490da015c6e226d1429560cfcd61 Mon Sep 17 00:00:00 2001 From: Eric Fennis Date: Thu, 25 Jun 2020 10:13:59 +0200 Subject: [PATCH] docs: Update CONTRIBUTING file (#17) * Update Contributing.md * Remove Bug reporting section --- CONTRIBUTING.md | 54 +++---------------------------------------------- 1 file changed, 3 insertions(+), 51 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 880b81a69..b0f2342be 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,13 +2,11 @@ :+1::tada: First off, thanks for taking the time to contribute! :tada::+1: -The following is a set of guidelines for contributing to Feather. Feel free to propose changes to this document in a pull request. +The following is a set of guidelines for contributing to Featherity. Feel free to propose changes to this document in a pull request. ## Pull Requests -> **Note:** At the moment we are not accepting pull requests containing _**icons**_. The best way to contribute an icon is to create an issue with a screenshot and link to an SVG of your icon. - -Pull requests for new features, bug fixes, etc. are often appreciated. Please checkout the [project roadmap](https://github.com/colebemis/feather#roadmap) and raise an issue to discuss any of the items on the list. +Feel free to open a pull-request to contribute to this project. **Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) @@ -23,50 +21,4 @@ Guidelines for pull requests: Before creating an icon request, please search to see if someone has requested the icon already. If there is an open request, please add a :+1:. -If the icon has not already been requested, [create an issue](https://github.com/colebemis/feather/issues/new?title=Icon%20Request:) with a title of `Icon request: ` and add as much information as possible. - -## Bug Reports - -Before reporting an issue, please search to see if someone has filed a similar issue before. If there is already an open issue, please add a :+1: and/or leave a comment with additional information. - -When creating a new issue make sure to include the following: -- Version of `Feather` in use. Are you running from source/master? Are you using a released build? Which release? -- Your environment. What is your operating system? 32 or 64 bits? -- Step to reproduce. Even if the step is only one line change, __include it!__ Include the actual result and what you expected. -- Any message or error you get in the console, if you do. -- A screenshot of any visual bug. - -Here is what a great bug report would look like: - -``` -## Prerequisites - -Version: Release v3.1.0 -Running from: Import using webpack -Operating system: Mac OSX -Bits: 64 bits - -## Step to reproduce - - - Import `check` icon - - Add to a React component/view - - Run the react app - - Notice that the `check` isn't rendering correctly which seems a encoding problem - -### Actual behavior: - - - Import `check` icon - - Add to a React component/view - - Run the react app - - Check is displayed with correct encoding (e.g UTF-8) - -## Any message or error - -No console output -... - -## Resources - -No resources -... -``` +If the icon has not already been requested, [create an issue](https://github.com/featherity/featherity/issues/new?title=Icon%20Request:) with a title of `Icon request: ` and add as much information as possible.