Skip to content

Latest commit

 

History

History
92 lines (53 loc) · 4.5 KB

CONTRIBUTING.md

File metadata and controls

92 lines (53 loc) · 4.5 KB
Raw

Contributing to WTF Chrome Extension

First off, thank you for considering contributing to the WTF Chrome Extension! It's people like you that make the open-source community such a great place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Code of Conduct

This project and everyone participating in it are governed by the WTF Chrome Extension Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to wtf@marcosvr.com.

I don't want to read this whole thing I just have a question!!!

Feel free to ask your question about the project in the issues section. It's also a great way to connect with other contributors.

What should I know before I get started?

Project Structure

The project primarily uses the following technologies:

  • React and React-DOM for the frontend
  • TypeScript for type-safe code
  • Webpack for bundling
  • Tailwind CSS for styling

Understanding these technologies will help you get up to speed quickly.

Development Environment

Please refer to the README.md file for instructions on setting up your development environment. It includes detailed steps on how to install, build, and run the extension locally.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for the WTF Chrome Extension. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for the WTF Chrome Extension, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.

Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.

Your First Code Contribution

Unsure where to begin contributing to WTF? You can start by looking through these beginner and help-wanted issues:

  • Beginner issues - issues which should only require a few lines of code, and a test or two.
  • Help wanted issues - issues which should be a bit more involved than beginner issues.

Pull Requests

The process described here has several goals:

  • Maintain the quality of WTF
  • Fix problems that are important to users
  • Engage the community in working toward the best possible WTF Chrome Extension
  • Enable a sustainable system for WTF's maintainers to review contributions

Please follow these steps to have your contribution considered by the maintainers:

  1. Follow all instructions in the template
  2. Follow the styleguides
  3. After you submit your pull request, verify that all status checks are passing

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

JavaScript Styleguide

All JavaScript must adhere to JavaScript Standard Style.

CSS Styleguide

Use BEM (Block Element Modifier) notation which is explained in the css-tricks guide.

Additional Notes

  • Don't include issue numbers in the PR title
  • Do include concise and specific commit messages for easier reviewing

Thank you for reading through the contributing guide, and welcome to the WTF Chrome Extension project!

Acknowledgments

Thanks to everyone who spends time contributing to open-source projects. We appreciate your dedications and contributions to making the web a better place.