Skip to content

Latest commit

 

History

History
130 lines (85 loc) · 5.36 KB

contributing.md

File metadata and controls

130 lines (85 loc) · 5.36 KB

Contributing to AutoSwappr

First off, thanks for taking the time to contribute!

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution.

It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions.

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

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

Table of Contents

Table of Contents

  1. Code of Conduct
  2. I Have a Question
  3. I Want to Contribute
  4. License
  5. Appreciation

Code of Conduct

This project and everyone participating in it is governed by the Contributor Covenant. By participating, you are expected to uphold this code. Please report unacceptable behavior to [developer's email].

I Have a Question

If you want to ask a question, we assume that you have read the available Documentation.

Before Asking a Question

  1. Search for existing Issues that might already answer your question.
  2. If an issue addresses your concern but you still need clarification, add your question to that issue.
  3. Search the internet for answers related to your question.

If You Still Have Questions

  1. Open a new Issue.
  2. Provide as much context as possible about your problem.
  3. Share project and platform versions (e.g., Node.js, npm) relevant to your question.

The team will address your issue as soon as possible.

I Want to Contribute

When contributing to this project, you agree:

  • That you have authored 100% of the content.
  • That you have the necessary rights to the content.
  • That the content you contribute may be provided under the project license.

Reporting Bugs

Before Submitting a Bug Report

To help us address bugs quickly, please follow these steps:

  1. Ensure you are using the latest version.
  2. Confirm that your issue is not caused by incompatible environment components or versions.
  3. Read the documentation to ensure the issue is not a misunderstanding.
  4. Check if the issue has already been reported in the bug tracker.
  5. Search the internet (e.g., Stack Overflow) for similar issues.

Collect Information About the Bug

  • Stack trace or traceback logs.
  • Operating System, Platform, and Version (e.g., Windows, Linux, macOS, x86, ARM).
  • Version of interpreter, compiler, SDK, or runtime environment, as applicable.
  • Steps to reproduce the issue consistently.
  • Relevant input and expected/actual outputs.

How to Submit a Good Bug Report

Note: Never report security-related vulnerabilities publicly. Instead, email such reports directly to the developer.

  1. Open a new Issue.
  2. Clearly explain the expected behavior and the actual behavior.
  3. Include detailed reproduction steps and any relevant code snippets.
  4. Provide all collected information (e.g., stack trace, platform details).

Once filed, the team will:

  1. Label the issue appropriately.
  2. Attempt to reproduce the issue using your provided steps. If steps are missing, the issue will be tagged needs-repro.
  3. Upon reproduction, the issue will be tagged needs-fix (and possibly others) and made available

Suggesting Enhancements

Enhancement suggestions include new features or improvements to existing functionality.

Before Submitting an Enhancement

  1. Ensure you are using the latest version.
  2. Check the documentation to confirm the feature doesn’t already exist.
  3. Search Issues to see if a similar suggestion exists. If it does, comment on that issue instead of creating a new one.
  4. Ensure your suggestion aligns with the project's scope and goals. Features that benefit the majority of users are prioritized.

How to Submit a Good Enhancement Suggestion

  1. Open a new Issue.
  2. Use a clear and descriptive title for your suggestion.
  3. Provide a detailed step-by-step description of the enhancement.
  4. Describe the current behavior, the desired behavior, and why the change is beneficial.
  5. Include screenshots, GIFs, or references to similar implementations for clarity.

License

By contributing to this project, you agree that your contributions will be licensed under the terms specified in the LICENSE file.

Appreciation

Thank you for considering contributing to this project! Your feedback and contributions make this community stronger and the project better for everyone.