Skip to content

Latest commit

 

History

History
95 lines (74 loc) · 2.58 KB

CONTRIBUTING.md

File metadata and controls

95 lines (74 loc) · 2.58 KB
Raw

Contributing to EverShop

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features

Developing

To develop locally:

  1. Fork this repository to your own GitHub account and then clone it to your local device.

    git clone https://github.com/evershopcommerce/evershop.git

  2. Create a new branch:

    git checkout -b MY_BRANCH_NAME

  3. Install the dependencies with:

    npm install

  4. Create a Postgres database:

    // EverShop use Postgres for database storage

  5. Run installation command to create a database schema:

    npm run setup

  6. Start development server:

    npm run dev

  7. Building

You can build with:

npm run build
  1. Testing the production build
npm run start
  1. Running tests

Run the Jest unit testing

npm run test
  1. Running linting
npm run lint
  1. Issue that pull request! to the dev branch.

Any contributions you make will be under the GNU General Public License v3.0 Software License

In short, when you submit code changes, your submissions are understood to be under the same GNU General Public License v3.0 that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background
    • What EverShop version you are using
    • What NodeJs version you are using
    • What OS system you are using
    • What Postgres version you are using
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

License

By contributing, you agree that your contributions will be licensed under its GNU General Public License v3.0 License.