Skip to content

Latest commit

 

History

History
32 lines (21 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

32 lines (21 loc) · 1.83 KB

Contributing to ArcAds

Welcome to the contribution guide for ArcAds. Here are some important resources to get you started:

Questions or Issues

If you have a general question or an issue please refer to our Frequently Asked Questions section which we'll update reguarly with questions. If you can't find an answer to your question please open an issue.

Testing

ArcAds has a series of unit tests built with Jest. We are always looking to improve our testing coverage , and request that if you create new functionality that you also include tests along with it.

Submitting changes

Please send a Pull Request to ArcAds with a clear list of what you've done (you read more about Github pull requests here). Please follow the best practices guide 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."

Best Practices

  • ArcAds gets linted with the airbnb style guide.
  • Code should be documented and commented using the ESDoc conventions.
  • Please make sure you've tested your code prior to submitting a pull request and ensure everything works.