Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
colebemis authored Aug 19, 2023
1 parent db2364f commit 77aa0d1
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Contribution Guidelines

:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
First off, thanks for taking the time to contribute!

The following is a set of guidelines for contributing to Feather. 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.
> **Note**: 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.

**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/courses/how-to-contribute-to-an-open-source-project-on-github)
[How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github).

Guidelines for pull requests:
- __Make your commit messages as descriptive as possible.__ Include as much information as you can. Explain anything that the file diffs themselves won’t make apparent.
Expand All @@ -21,13 +21,13 @@ Guidelines for pull requests:

## Icon 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:.
Before requesting an icon, please search the [open issues](https://github.com/feathericons/feather/issues) to see if someone has requested the icon already. If there is already an open request, please add a :+1: to the existing issue instead of creating a new one.

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: <icon name>` 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.
Before reporting an issue, please search to see if someone has filed a similar issue. 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?
Expand Down

0 comments on commit 77aa0d1

Please sign in to comment.