-
Notifications
You must be signed in to change notification settings - Fork 2
Contribution Guide
If you a new contributor, before your contributions can be accepted, you will be asked to post the following in the issue:
By making a contribution to this project, I certify that the contributions I make to this project are created in whole by me and I have the right to submit it under the BSD-3-Clause license; OR the contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the BSD-3-Clause license. I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
This allows us to accept your contribution as you are declaring that you own the copyright to the contribution. Spectrum is licensed under BSD-3-Clause, which enables other developers and entities to use your commits in distributions of Spectrum forked versions of their own projects. It is similar to and compatible with the MIT license. BSD-3-Clause has an additional "no endorsement" clause (more info).
If you are writing code, please follow the following best practices. PRs that do not follow the best practice guide will be rejected.
You must adhere to the linting rules set out in the .eslintrc file. It is recommended you use a text editor that is compatible with eslint. You can run npm run lint to ensure your PR will be accepted.
Take advantage of the new features of ES6, especially deconstructing and class definitions. In general, try to keep things DRY and declarative ({ myProp } = this.props; is better than using this.props.myProp).
When implementing components, please utilize Styled Components as much as possible for styling.