Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 2.34 KB

CONTRIBUTING.md

File metadata and controls

40 lines (26 loc) · 2.34 KB
Raw

Contributing to [TechByte]

Firstly, thank you for considering contributing to [TechByte]! It's people like you that make [Computer Store Name] such a great tool.

How to contribute

There are many ways you can help contribute to [TechByte] and every type of contribution is highly appreciated!

Reporting Issues

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

  • Before submitting an issue, please check the issue tracker to avoid duplication.
  • 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.

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

Great to hear you're thinking about making a pull request! Here's what you need to know:

  • Before creating a pull request, ensure you have an issue to link it to. This ensures there's a discussion associated with the proposed changes.
  • Do not include issue numbers in the PR title.
  • Follow the coding conventions used throughout the project, including indentation, accurate comments, and a clear code structure.
  • Follow the pull request template provided.
  • Continuous Integration services are used to check all pull requests, so ensure your code passes all tests before submitting.
  • Include screenshots and animated GIFs in your pull request whenever possible.

Pull Request Guidelines

  • The main branch is basically just a snapshot of the latest stable release. All development should be done in dedicated branches. Do not submit PRs against the master branch.
  • Checkout a new branch from master and name it to what you intend to do:
    • feature/... if you're adding a new feature
    • bugfix/... if you're fixing a bug
  • If you've made changes to the API, update the documentation accordingly.
  • Ensure that your code adheres to the existing style of the project to maintain consistency.

Thank you for reading, and for your interest in contributing!