Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (31 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

44 lines (31 loc) · 2.48 KB
Raw

Contributing

TL;DR

One of the easiest ways to contribute is to participate in discussions and discuss issues. You can also contribute by submitting pull requests with code changes. Just follow rules used in Open Source projects on GitHub.com.

How to contribute

Contributions to RetroPlus are welcomed in the form of constructive, reproducible bug reports, feature requests that align to the project's goals, or better still a PR that's accompanied with passing tests.

If you have general questions or feedback about using RetroPlus, PLEASE DON'T CREATE AN ISSUE AND POST TO STACKOVERFLOW INSTEAD.

Please read the GitHub flow documentation. TL;DR there's only one rule: anything in the master branch is always deployable.

Bug Reports

If you're reporting a bug, please include a clear description of the issue, the version of RetroPlus you're using, and a set of clear repro steps.

Please remember that RetroPlus is a free and open-source project provided to the community with zero financial gain to the author(s). Any issues deemed to have a negative or arrogant tone will be closed without response.

Feature Requests

If you're requesting a feature, please include a clear description of the feature.

Pull Requests

If you've identified a feature/bug fix that aligns to the project goals, or even just an addition to the docs, please submit a Pull Request (PR). If applicable, include tests and ensure all tests are passing locally before you commit.

Squash and Merge

When completing a PR you squash and merge the commits to create a more streamlined Git history in the repository. Work-in-progress commits are helpful when working on a feature branch, but they aren’t necessarily important to retain in the Git history. If you squash these commits into one commit while merging to the default branch, you can retain the original changes with a clear Git history.

The resulting squashed commit message should be a short description of what has been changed and the references to the PR and the resolved issues.

Updated view X (#9) #2 #1

And the resulting squashed commit message details can some more information.

View now shows more details

Creating a new release

  1. Create and push a new tag with the version number, e.g. 1.2.3 (SemVer 2.0.0). Do not prefix with the version number!
  2. A new release will now be available.