Skip to content
This repository has been archived by the owner on Oct 2, 2020. It is now read-only.

Latest commit

 

History

History
47 lines (29 loc) · 2.59 KB

CONTRIBUTING.md

File metadata and controls

47 lines (29 loc) · 2.59 KB

How to contribute to xd2svg

I'm really glad you're reading this, because this project need volunteer developers to help release functionality which would convert any Adobe XD files to SVG images.

Contributing reasons

Did you find a bug?

  • Check Issues and make sure that the bug was not reported yet.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

  • Use labels for your issue, if you don't know about issues, please, read Labeling issues and pull requests articles

  • If possible, use the bug report templates to create the issue.

Did you write a patch that fixed bug?

  • Open a new GitHub pull request with the patch and add appropriate label.

Did you fix whitespace, format code, or make a purely cosmetic patch?

I guess in most cases this pull will not be accepted

Do you intend to add a new feature or change an existing one?

  1. Check Issues and Pull Requests and make sure that this feature are not implementing by anything yet
  2. Create new Issue with title Feature/<name-of-feature> and describe it
  3. Implement function in your own branch and send a pull request

Do you have questions about the source code?

  1. Try to find this question in Issues
  2. If you didn't find related issue you can create new one with you question and appropriate label

Submitting changes

Please send a GitHub Pull Request to xd2svg with a clear list of what you've done (read more about pull requests). Please follow our coding conventions (below) and make sure all of your commits are atomic (one feature per commit).

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

 $ git commit -m "A brief summary of the commit
 > 
 > A paragraph describing what changed and its impact."

Coding conventions

tslint should pass w/o errors