Skip to content

Latest commit

 

History

History
100 lines (70 loc) · 3.35 KB

CONTRIBUTING.md

File metadata and controls

100 lines (70 loc) · 3.35 KB
Raw

Contributing

Thanks for being interested in contributing to this project!

Development

To improve our development process, we've provide a playground, you can use any package in playground. Vr360 uses a monorepo structure and packages/package can be consumed in isolation.

Setup

The following steps will get you up and running to contribute to Vr360:

  1. Fork the repo (click the Fork button at the top right of this page)

  2. Clone your fork locally

git clone https://github.com/<your_github_username>/vr360.git
cd vr360
  1. Install Dependencies. This project depends on node v14+ and pnpm 6.x

If you don't have pnpm installed, you should execute:

npm i -g pnpm@6.32.17

Install the dependencies:

pnpm bootstrap

We use VuePress for rapid development and documenting. You can start it locally by

cd packages/doc-site
pnpm dev

Commit Convention

Before you create a Pull Request, please check whether your commits comply with the commit conventions used in this repository.

When you create a commit we kindly ask you to follow the convention category(scope or module): message in your commit message while using one of the following categories:

  • feat / feature: all changes that introduce completely new code or new features
  • fix: changes that fix a bug (ideally you will additionally reference an issue if present)
  • refactor: any code related change that is not a fix nor a feature
  • docs: changing existing or creating new documentation (i.e. README, docs for usage of a lib or cli usage)
  • build: all changes regarding the build of the software, changes to dependencies or the addition of new dependencies
  • test: all changes regarding tests (adding new tests or changing existing ones)
  • ci: all changes regarding the configuration of continuous integration (i.e. github actions, ci system)
  • chore: all changes to the repository that do not fit into any of the above categories

If you are interested in the detailed specification you can visit https://www.conventionalcommits.org/ or check out the Angular Commit Message Guidelines.

Steps to PR

  1. Fork of the vvr360 repository and clone your fork

  2. Create a new branch out of the master branch. We follow the convention [type/scope]. For example fix/vr360-core or docs/vr360-ui. type can be either docs, fix, feat, build, or any other conventional commit type. scope is just a short id that describes the scope of work.

  3. Make and commit your changes following the commit convention. As you develop, you can run pnpm --filter <module> build and pnpm --filter <module> test to make sure everything works as expected. Please note that you might have to run pnpm bootstrap first in order to build all dependencies.

Code Style

Don't worry about the code style as long as you install the dev dependencies. Git hooks will format and fix them for you on committing.

Thanks

Thank you again for being interested in this project! You are awesome!

License

By contributing your code to the vr360 GitHub repository, you agree to license your contribution under the MIT license.