Skip to content

Latest commit

 

History

History
95 lines (62 loc) · 3.74 KB

CONTRIBUTING.md

File metadata and controls

95 lines (62 loc) · 3.74 KB
Raw

Contributing to WhoCanUse?

First off, thanks for taking the time to contribute! ❤️

Here are some of the ways you can help:

✨ And if you like the project, but don't have time to contribute, here are some other ways to support the project and show your appreciation:

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

Reporting Bugs

Github issues are the preferred channel for submitting bug reports.

Here are some tips on writing a good bug report:

  • Use a clear and descriptive title that identifies the problem
  • Describe the current behavior and explain the behavior you expected to see instead and why
  • Include screenshots and animated GIFs where appropriate
  • List the environments/browsers/OS where you experienced the problem

These details will help people troubleshoot any potential bugs

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues.

Suggested enhancements are welcome, though it's up to you to make a case for the merits of the feature. There's a better chance of the enhancment being considered when you provide sufficient detail and context 🙂

Here are some tips on writing a good enhancement suggestion:

  • Use a clear and descriptive title for the suggestion
  • Provide a step-by-step description of the suggested enhancement
  • Describe the current behavior and explain the behavior you expected to see instead and why
  • Include screenshots and animated GIFs to help explain the steps or area the suggestion is related to
  • Explain why this enhancement would be useful and who it would most benefit

Contributing to code

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

Issues tagged with the following labels are good places to start:

  • help wanted - issues we're actively looking for help with!
  • bug - something isn't working as expected
  • enhancement - issues asking for a new feature to be added, or an existing one to be extended or modified

The following provides some guidelines for pull requests:

  • Express your interest on an issue before starting on any significant PR
  • For smaller tasks feel free to go ahead and submit a PR
  • Give your PR a clear title and description
  • Each PR should focus on only one feature/fix. (Multiple things = multiple PRs)
  • If you're solving an issue, link to it in your PR
  • Check the "Allow edits by maintainers" checkbox for collaboration

Getting Started

  1. Fork and clone the repo.

  2. Install everything.

    Navigate to wherever you cloned the whocanuse repo to and install all the things:

    npm install

  3. Start the dev server.

    npm run dev

    Your site is now running at http://localhost:3000!

  4. Create a feature branch and make your changes

    Commit your changes in logical chunks with clear commit messages.

  5. Push and submit a PR

    Push your feature branch up to your cloned repository.

    Open a pull request against the main original branch.

That's it! 🎉

Thank you for contributing ❇️

License

By contributing code, you agree to license your contribution under the MIT license