Skip to content

Latest commit

 

History

History
54 lines (27 loc) · 3.49 KB

CONTRIBUTING.md

File metadata and controls

54 lines (27 loc) · 3.49 KB

Welcome

Thank you for contributing to the BrightSign Dev Cookbook!

Contributing Guidelines

  • Code Style: Please adhere to the coding conventions as defined in .eslintrc. Run yarn format before submitting.
  • Commit Messages: Write clear, concise commit messages that explain the changes made. Use Conventional Commit style messages.
  • Pull Requests: For substantial changes, it's best to open an issue for discussion before submitting a pull request.

We look forward to your contributions and suggestions!

How to submit changes

To contribute enhancements or fixes to dev-cookbook, please follow these steps:

  1. Fork and Clone: Start by forking the dev-cookbook repository. Then, clone your fork locally to make changes.

  2. Make Changes: Navigate to the specific template or example you wish to improve within the dev-cookbook directory. Apply your changes there.

  3. Test Locally: Test the template by instantiating using the command mentioned in the "Using the Template" section. This step ensures your changes work as expected within the create-react-app workflow. If it is an example-*, test your changes according to the instructions in the example Readme.

  4. Commit Changes: After testing your changes, commit them to your fork. Ensure your commit messages clearly describe the enhancements or fixes made. Push your commits to GitHub.

  5. Submit a Pull Request (PR): Submit a pull request to the main dev-cookbook repository. Be sure to fill out the predefined PR sections as fully as possible.

  6. Code Review: Once your PR is submitted, it will be reviewed by a BrightSign team member. Be open to feedback and ready to make further adjustments based on their suggestions.

Modifying cra-template-* examples

cra-template-* examples can be run on your development machine (via yarn start) for rapid iteration, with some caveats. The full functionality of @brightsign API modules are only available on the device, but we have added partial mock implementations for you to develop with locally. Please refer to the JavaScript API Documentation for further details on each API so that you may extend the existing mocks.

You can also extend or create new tests (App.test.js) and run them with yarn run test in each example directory dev-cookbook, or in every workspace by running yarn run test at the root of the project.

If you want to contribute improvements back to dev-cookbook, either make your changes directly in the repo or copy them from your create-react-app project after you have verified them locally and on a device. Be sure to maintain the same directory structure.

Git hooks

dev-cookbook uses husky to automatically run eslint and prettier on commit to maintain code quality. There is also a hook to run tests before pushing to a remote branch. If you would like to suggest improvements, take a look at the hooks configuration in the .husky directory.

How to report a bug

Create a new issue. Be sure to describe the bug and provide clear repro steps.

How to request new examples

Create a new issue. Describe the problem you are trying to solve and why a new example would be useful. A BrightSign team member will review.

Copyright

By contributing to this repo, you agree to license any code submitted under the MIT license. For larger contributions, we may request a Contributor License Agreement.