Contributions in the form of ideas, designs, and code are always welcome no matter how large or small. If you want to help but are not sure where to start, you can check out our project's Issues.
We do use Yarn in this project, so:
Install yarn: https://yarnpkg.com/en/docs/install
Afterward, clone our repository:
$ git clone https://github.com/gloriajs/gloria.git $ cd gloria/ $ yarn
When adding a new dependency to our project, we use
yarn add [package name] rather than
npm install [--save or --save-dev] [package name]. It keeps our
yarn.lock file (and therefore our dependencies) consistent across all our contributors.
npm link inside the root folder to use your local development
gloria instead of the globally installed one.
or just use
$ node bin/gloria [command]
$ npm test
We actively welcome any pull requests that are backed up by current issues or by some small summary explaining what it is you're contributing.
- Fork the repo and create a branch from your fork's
master. Name the branch after what it is you're doing, like
- If you've added code that should be tested, add tests to the
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
By contributing to Gloria, you agree that your contributions will be licensed under its Apache license.
We recommend using the git flow method, to know what type of code is going in every branch.
Installing the addon git flow will facilitate this.
We use jsc to make sure the style in the code is similar across every developer.
Arbitrarily we decided to use the airbnb style guide. You can learn more about it in their github repo.
Look at our .jscrc file.
Pull requests that don't adhere to the code style will probably get rejected, or commented with some advice.
The code style includes things like how to do indentation, how to declare variables, allowed capitalization, etc.
Testing Pull Requests
A great way to contribute too is to look at the pull requests opened by other contributors.
To check out locally the code pushed by others, look at this guide put together by github.
Code of Conduct
Keep in mind our code of conduct when participating.