Skip to content

Latest commit

 

History

History
93 lines (67 loc) · 2.9 KB

CONTRIBUTING.md

File metadata and controls

93 lines (67 loc) · 2.9 KB

Contributing to NGXS

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to NGXS and its packages.

Table Of Contents

I don't want to read this whole thing, I just have a question!!!

How can i help?

Developing

Building

Publish new version

I don't want to read this whole thing I just have a question!!!

Note: Please don't file an issue to ask a question.

How can i help?

Check the issues where we have labels for help wanted. Also chat us up on slack, where we will be more than happy to get you started on an issue.

Developing

Start by installing all dependencies

yarn

You can then either start develping using TDD

yarn test

Or start the integration app and start playing around

yarn start

Building

Since our library is a combination of the main @ngxs/store and the plugins, we need to build them into separate npm packages and publish them.

running

yarn build

will create a build for each package in the builds/ directory.

Linking

If you want to test out a local build in your own app you can create a global symlink for the package which can then be linked locally in your app.

# build ngxs
yarn build

# cd into the build you want to link
cd builds/store

# create the global symlink
yarn link

now navigate to your app then run

yarn link @ngxs/store

now node_modules/@ngxs/store will be symlinked to the local build directory of @ngxs/store. to make a change, save the file in ngxs, run yarn build and your app should now be using the new build.

Publishing new version

(@ngxs team members only)

Dev builds

circleci picks up all commits to master, which is our development branch. It then runs the build, the tests, the integration tests, and if they all succeed, circleci will publish to code climate, and to npm using the git commit sha1 as an identified 3.0.0-dev.6e59e7b and tag it as @dev

Beta builds

@todo need to figure out how to get the prerelease version and use it as the git tag, before we can automate the @beta releases

Release builds

circleci picks up when a git tag is created and does the same thing as for the development build, but instead of releasing a dev build, releases the version that was specified in the root package.json in the git tag. it also tags it as @latest