Skip to content
This repository has been archived by the owner on Sep 12, 2022. It is now read-only.

Latest commit

 

History

History
40 lines (27 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

40 lines (27 loc) · 1.71 KB
Raw

Contributing to this repository

Thanks for your interest in SvgHero!

Getting started

Before you begin:

  • This project is powered by Node.js, Electron and React. Check to see if you're on the Nodejs version 14.x.
  • Have you read the code of conduct?
  • Check out the existing issues.

In time, we'll tag issues that would make a good first pull request for new contributors. An easy way to get started helping the project is to file an issue. You can do that on the SvgHero issues page by clicking on the green button at the right. Issues can include bugs to fix, features to add, or documentation that looks outdated.

Contributions

SvgHero welcomes contributions from everyone.

Contributions to SvgHero should be made in the form of GitHub pull requests. Each pull request will be reviewed by a core contributor (someone with permission to land patches) and either landed in the main tree or given feedback for changes that would be required.

Pull Request Checklist

  • Branch from the master branch and, if needed, rebase to the current master branch before submitting your pull request. If it doesn't merge cleanly with master you may be asked to rebase your changes.

  • Commits should be as small as possible, while ensuring that each commit is correct independently (i.e., each commit should compile and pass tests).

  • Don't put submodule updates in your pull request unless they are to landed commits.

  • If your patch is not getting reviewed or you need a specific person to review it, you can @-reply a reviewer asking for a review in the pull request or a comment.

  • Add tests relevant to the fixed bug or new feature.