Skip to content

Latest commit

 

History

History
98 lines (78 loc) · 4.77 KB

CONTRIBUTIONS.md

File metadata and controls

98 lines (78 loc) · 4.77 KB
Raw

Contributing to Betterize

Thank you for considering contributing to Betterize! 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 is governed by a Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [stephenmichaelirving@gmail.com] or via Twitter/X DM to <@metric_dev>.

  • Be friendly and patient: Remember you might not be communicating in someone else’s primary spoken or programming language, and others may not have your level of understanding.
  • Be welcoming: Our communities welcome and support people of all backgrounds and identities. This includes, but is not limited to members of any race, ethnicity, culture, national origin, color, immigration status, social and economic class, educational level, sex, sexual orientation, gender identity and expression, age, size, family status, political belief, religion, and mental and physical ability.
  • Be respectful: We are a world-wide community of professionals, and we conduct ourselves professionally. Disagreement is no excuse for poor behavior and poor manners. Disrespectful and unacceptable behavior includes, but is not limited to:
    • Violent threats or language.
    • Discriminatory or derogatory jokes and language.
    • Posting sexually explicit or violent material.
    • Posting, or threatening to post, people’s personally identifying information (“doxing”).
    • Insults, especially those using discriminatory terms or slurs.
    • Behavior that could be perceived as sexual attention.
    • Advocating for or encouraging any of the above behaviors.
  • Understand disagreements: Disagreements, both social and technical, are useful learning opportunities. Seek to understand the other viewpoints and resolve differences constructively.

This code is not exhaustive or complete. It serves to capture our common understanding of a productive, collaborative environment. The code should followed in spirit as much as in the letter.

Basically: Just be KIND, COOL, & CHILL!

There is literally zero reason for you to be behave in any other manner while contributing to open source.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for Betterize. 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.

How Do I Submit A (Good) Bug Report?

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

Explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible. When listing steps, don't just say what you did but explain how you did it.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
  • 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 or video which show you following the described steps and clearly demonstrate the problem.

To report issues, go to the issues section.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Betterize, including new fixes, features, and minor improvements.

  • Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.
  • Define the problem you're trying to solve with this enhancement.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include copy/pasteable snippets.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Explain why this enhancement would be useful to most Betterize users.

Thank you for contributing to Betterize, and we look forward to your contributions!