Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
112 lines (73 loc) · 7.77 KB

CONTRIBUTING.md

File metadata and controls

112 lines (73 loc) · 7.77 KB
Raw

Contributing to bfa-shadow-priest

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to bfa-shadow-priest, which are part of efforts made by the HowToPriest Shadow Theorycrafting team. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table Of Contents

Code of Conduct

What should I know before I get started?

How Can I Contribute?

Styleguides

Additional Notes

Code of Conduct

This project and everyone participating in it is governed by the bfa-shadow-priest Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to publik@exiledpower.com.

I don't want to read this whole thing I just have a question!!!

How Can I Contribute?

Creating Issues

This section guides you through submitting an issue for bfa-shadow-priest. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.

Before creating issues, 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.

Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

Before Submitting an Issue

How Do I Submit an Issue?

Issues 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 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. For example, start by explaining how you started SimC, e.g. which command exactly you used in the terminal, or the exact profile used. When listing steps, don't just say what you did, but explain how you did it. For example, if ran a profile, explain the settings used to run 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.
  • Provide relevant comparrisons between SimC behavior and in-game behavior with matching stats
  • If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.

Provide more context by answering these questions:

  • Did the problem start happening recently (e.g. after updating to a new version of SimC) or was this always a problem?
  • If the problem started happening recently, can you reproduce the problem in an older version of SimC? What's the most recent version in which the problem doesn't happen? You can download older versions of SimC from the releases page.
  • Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.

Pull Requests

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

Python Styleguide

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

The labels are loosely grouped by their purpose, but it's not required that every issue have a label from every group or that an issue can't have more than one label from the same group.

Please open an issue if you have suggestions for new labels, and if you notice some labels are missing on some repositories, then please open an issue on that repository.

Type of Issue and Issue State

Label name Link Description
enhancement search Feature requests.
bug search Confirmed bugs or reports that are very likely to be bugs.
question search Question inside the issue needs to be answered.
help-wanted search Needs someone to work on the issue
needs-reproduction search Likely bugs, but haven't been reliably reproduced.
blocked search Issues blocked on other issues.
duplicate search Issues which are duplicates of other issues, i.e. they have been reported before.
wontfix search The Priest team has decided not to fix these issues for now, either because they're working as intended or for some other reason.
analysis search The type of the issue requires analysis work.
apl search The type of the issue requires APL work.
simc module search The type of the issue requires simc module work.