Skip to content

Latest commit

 

History

History
128 lines (84 loc) · 4.06 KB

CONTRIBUTING.md

File metadata and controls

128 lines (84 loc) · 4.06 KB
Raw

Contributing

Contributions are always welcome, no matter how large or small. Before contributing, please read the code of conduct.

Some thoughts to help you contribute to this project

General Recommendations

  1. Always discuss your suggested contribution in an issue, so that we agree on the concept and implementation before the actual work.
  2. Leave a detailed description in the Pull Request.
  3. Screenshots are preferable for visuals changes.
  4. Always communicate. Whether it is in the issue or the pull request, keeping the lines of communication helps everyone around you.
  5. If you have any questions, let's discuss.

Get Started

  1. Fork the repo https://github.com/live-codes/livecodes

  2. Clone

    $ git clone https://github.com/<your-name>/livecodes
$ cd livecodes

  3. Install dependencies

    $ npm install

  4. Build

    $ npm run build

  5. Serve the app on http://127.0.0.1:8080

    $ npm run serve

  6. Start the app and watch for changes

    $ npm run start

  7. Start the docs and watch for changes: http://localhost:3000/docs

    $ npm run docs

  8. Start storybook and watch for changes: http://localhost:6006

    $ npm run storybook

  9. Run linters, formatters & unit tests

    $ npm run test

  10. Run e2e tests

$ npm run e2e

  1. Deploy to GitHub Pages (make sure you have built the app first)

    $ npm run gh-pages

  2. Start a release (more details)

    $ npm run start-release

Pull Requests

We actively welcome your pull requests, however linking your work to an existing issue is preferred.

  1. Fork the repo and create your branch from develop.
  2. Name your branch something that is descriptive to the work you are doing. i.e. adds-new-thing or fixes-mobile
  3. If you've added code that should be tested, add tests.
  4. If you've changed APIs, update the documentation.
  5. If you make visual changes, screenshots are required.
  6. Ensure the test suite passes.
  7. Make sure you address any lint warnings.
  8. If you make the existing code better, please let us know in your PR description.
  9. A PR description and title are required.
  10. Link to an issue in the project. An issue is required to announce your intentions and discuss decisions.

Commit Messages

This project uses Conventional Commits to automatically generate changelog.

Work in progress

GitHub has support for draft pull requests, which will disable the merge button until the PR is marked as ready for merge.

Issues

If you plan to contribute a change based on an open issue, please assign yourself by commenting on the following word .take. Issues that are not assigned are assumed open, and to avoid conflicts, please assign yourself before beginning work on any issues.

If you would like to contribute to the project for the first time, please consider checking the docs, bug or good first issue labels.

Also, all questions are welcomed.

Specific Topics

Funding

LiveCodes is a part of GitHub Sponsors. If you would like to contribute, please note the sponsor page for details.

License

By contributing to the LiveCodes project, you agree that your contributions will be licensed under its MIT license.