👍🎉 First off, thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to XML-to-React which is hosted in the Condé Nast Organization on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
This project and everyone participating in it is governed by a Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
Open a new issue. Follow the provided template as a guideline.
Open a new pull request. Follow the provided template as a guideline.
You must use Node.js version 8.9.x and npm version 5.x for development.
In order to make changes to the code, run the run the following commands in your terminal:
$ git clone https://github.com/CondeNast/xml-to-react.git
$ cd xml-to-react
$ npm i
In order to run the linter and unit test suite, run the following command in terminal:
$ npm test
Ensure that the filename of a test file ends with .test.js
, and place your test files in the test/
directory.
These Contributing Guidelines are adapted from the Atom Contributing Guidelines, available at https://github.com/atom/atom/blob/master/CONTRIBUTING.md and the Rails Contributing Guidelines available at https://github.com/rails/rails/blob/master/CONTRIBUTING.md.