Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

49 lines (34 loc) · 1.68 KB
Raw

First Pull Request!

  1. Always discuss your project first with an Issue!

    This prevents your precious time when the maintainer later decides to not include (aka later maintain) the contribution.

  2. Clone the repository on GitHub into your personal space.

  3. Develop your change

  4. Create a Pull Request against sharpbrick/poweredup:master (or a release-x.y branch for hotfixes).

  5. Have the discussion.

  6. Pull Request is merged by maintainer.

Filing Issues

  • Do not worry, just file one.
  • An Issue is not a bug. It might, but not neccessarily.
  • If you have a question, file an issue! (label as question)
  • If you have an idea, file an issue!
  • If you have a suggestion, file an issue!
  • If you think it is a bug, do not forget the following information
    • Library Version
    • Which steps are needed to reproduce the bug
    • Code Example (from a blank project) which reproduce the bug
    • Environemnt (.NET Version, Operating System, ...)

Styleguides

Emojis are okay. With taste ;). GIFs are not.

Git Commit Messages

<headline>

- <list of stuff changes>
- <more list>

#<issue ids> (breaking|non-breaking)

Please adhere to the common maximum line length (72 chars).

Please declare for each commit whether the change is considered breaking (see docs/arch/breaking.md)

Source Code

  • Any source contribution has to follow the established style within the given file or file group.
  • This project follows the .NET Framework Guidelines.
  • Please do not submit a pull request for the sake of reformatting source code to adhere to a style. If there is a serious concern, file a issue and have a discussion.