Skip to content

Latest commit

 

History

History
59 lines (36 loc) · 2.99 KB

CONTRIBUTING.md

File metadata and controls

59 lines (36 loc) · 2.99 KB
Raw

Contributing to backstage-plugin

Where to Begin!

If you have any queries or requests about backstage-plugin please create an issue on GitHub. If you want to comment or ask questions to the contributors start by joining our community and drop your questions in the #litmus-dev channel.

We welcome contributions of all kinds

  • Development of features, bug fixes, and other improvements.
  • Bug and feature reports.

Steps to Contribute

Fixes and improvements can be directly addressed by sending a Pull Request on GitHub. Pull requests will be reviewed by one or more maintainers and merged when acceptable.

We ask that before contributing, please make the effort to coordinate with the maintainers of the project before submitting large or high impact PRs. This will prevent you from doing extra work that may or may not be merged.

Use your judgement about what constitutes a large change. If you aren't sure, send a message to the #litmus-dev slack or submit an issue on GitHub.


Sign your work with Developer Certificate of Origin

To contribute to this project, you must agree to the Developer Certificate of Origin (DCO) for each commit you make. The DCO is a simple statement that you, as a contributor, have the legal right to make the contribution.

See the DCO file for the full text of what you must agree to.

To successfully sign off your contribution you just add a line to every git commit message:

Signed-off-by: Joe Smith <joe.smith@email.com>

Use your real name (sorry, no pseudonyms or anonymous contributions.)

If you set your user.name and user.email git configs, you can sign your commit automatically with git commit -s. You can also use git aliases like git config --global alias.ci 'commit -s'. Now you can commit with git ci and the commit will be signed.


Submitting a Pull Request

To submit any kinds of improvements, please consider the following:

  • Submit an issue describing your proposed change.
  • We would promptly respond back to your issue
  • Fork this repository, develop and test your code changes. See the Highlighted Repositories section below to choose which area you would like to contribute to.
  • Create a feature branch from your forked repository and submit a pull request against this repo’s main branch.
    • If you are making a change to the user interface (UI), include a screenshot of the UI changes.
  • Follow the relevant coding style guidelines
  • Your branch may be merged after review.

Important Links