Skip to content

Latest commit

 

History

History
66 lines (41 loc) · 3.11 KB

CONTRIBUTING.md

File metadata and controls

66 lines (41 loc) · 3.11 KB
Raw

Contributing to Perrito WS

First off, thank you for considering contributing to Perrito WS! It's people like you that make the open-source community such a fantastic 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 Perrito WS Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [[email protected]].

How Can I Contribute?

There are many ways you can contribute to Perrito WS, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests, or writing code which can be incorporated into Perrito WS itself.

Reporting Bugs

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

  • Use the search to see if the bug has already been reported.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Feature Requests

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.

Pull Requests

The process described here has several goals:

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

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

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

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/TypeScript Styleguide

CSS Styleguide

  • Use BEM (Block Element Modifier) naming conventions.
  • Use HEX color codes unless using rgba().

Where can I ask for help?

If you have any questions, open an issue and tag it as a question.

Thank you for contributing to Perrito WS!