Skip to content

Latest commit

 

History

History
59 lines (36 loc) · 3.43 KB

CONTRIBUTING.md

File metadata and controls

59 lines (36 loc) · 3.43 KB
Raw

Contributing to reduced-motion

First off, thank you for considering contributing to reduced-motion. It's people like you that make the open source community such a fantastic place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Code of Conduct

This project and everyone participating in it is governed by the reduced-motion Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [lucianmurmurache@gmail.com].

How Can I Contribute?

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

Reporting Bugs

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

Before Submitting A Bug Report

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, go ahead and open a new one.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. Create an issue and provide the following information by filling in the template.

Explain the problem and include additional details to help maintainers understand the issue:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as much detail as possible.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.

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 reduced-motion's quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible reduced-motion
  • Enable a sustainable system for reduced-motion's maintainers to review contributions

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

Final Words

Contributions to reduced-motion are highly encouraged and desired. Please respect the contribution guidelines detailed above to ensure a smooth collaboration process.

Thank you for your contributions!