Skip to content

Latest commit

聽

History

History
63 lines (40 loc) 路 3.98 KB

CONTRIBUTING.md

File metadata and controls

63 lines (40 loc) 路 3.98 KB
Raw

Contributing to Awesome Feature Management

First off, thanks for taking the time to contribute! 鉂わ笍

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 馃帀

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Tweet about it
  • Refer this project in your project's readme
  • Mention the project at local meetups and tell your friends/colleagues

Table of Contents

I Have a Question

If you want to ask a question, we assume that you have already reviewed existing Issues.

In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

  • Open an Issue.
  • Provide as much context as you can about what you're running into.
  • Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.

We will then take care of the issue as soon as possible.

I Want To Contribute

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Adding something to an awesome list

If you have something awesome to contribute to this awesome list, here is how you'll do it.

You'll need a GitHub account!

  1. Click on the readme.md file:
  2. Now click on the edit icon.
  3. You can start editing the text of the file in the in-browser editor. Make sure you follow guidelines above. You can use GitHub Flavored Markdown.
  4. Say why you're proposing the changes, and then click on "Propose file change".
  5. Submit the pull request!

Ensure your pull request adheres to the following guidelines:

  • Make sure that your submission is really awesome. Awesome lists are curations of the best, not everything.
  • Try to add a short description of the link you are adding by following the convention. Try to credit the author(s) by linking a Twitter/GitHub profile (or website/portfolio):
- [Name of the resource](<link>): <short description> by [@<author1 nickname>](<link to author1 profile>) & [@<author2 nickname>](<link to author2 profile>)
  • Choose the best link of all, that makes the navigation and the understanding of the resource the easiest possible. (i.e. prefer linking a GitHub repository over its demo link, moreover if the demo does no link back to the repository. The demo link is certainly linked anyway in the repo)
  • Ensure that your submission is in the right category. If it does not fit anywhere, propose a new category or sub-category that we will review in the PR.

Updating your Pull Request

A lot of times, making a PR adhere to the standards above can be difficult. If the maintainers notice anything that we'd like changed, we'll ask you to edit your PR before we merge it.

There's no need to open a new PR, just edit the existing one. If you're not sure how to do that, here is a guide on the different ways you can update your PR so that we can merge it.