Skip to content

Latest commit

 

History

History
178 lines (105 loc) · 3.81 KB

contributing.adoc

File metadata and controls

178 lines (105 loc) · 3.81 KB
Raw

Contributing to Modzy's Javascript SDK





GitHub contributors GitHub last commit GitHub Release Date

Contributor Covenant






Contributions are welcome and they are greatly appreciated! Every little bit helps, and credit will always be given.

Below you’ll find our contributing requirements, a step-by-step guideline, and our features roadmap.

Requirements

  • Search previous issues before making new ones to avoid duplicates.

  • If you are reporting a bug, please include:

    1. Your operating system name and version.

    2. Any details about your local setup that might be helpful in troubleshooting.

    3. Detailed steps to reproduce the bug.

  • If you are proposing a feature:

    1. Explain in detail how it would work.

    2. Keep the scope as narrow as possible, to make it easier to implement.

    3. Remember that this is a volunteer-driven project, and that contributions are welcome.

  • File an issue to let us know what you’re working on.

  • Fork the repo, develop and test your code changes, and add supporting documentation.

  • Use descriptive comments throughout your code.

  • Add test cases and comment them.

  • Use descriptive commit messages that clearly explain the changes. Reference the original issue in the pull request.

  • Make an individual pull request for each issue.

Guidelines

1. Fork the repo and set it for local development

Clone the repository:

Install dependencies:

  • $ yarn install or $ npm install

Create a branch for your awesome new feature:

  • $ git checkout -b my-awesome-new-feature

2. Develop your changes

Fix that bug or build your feature.

3. Run unit tests

Configure the environment variables to easily run all the tests with a single configuration point.

You can:

Set environment variables in bash

Windows
set MODZY_BASE_URL=http://modzy.com/api
set MODZY_API_KEY=my_key.modzy
Unix
export MODZY_BASE_URL=http://modzy.com/api
export MODZY_API_KEY=my_key.modzy

Use .env file

Create a .env file in the root folder with your API key:

MODZY_BASE_URL=http://modzy.com/api
MODZY_API_KEY=my_key.modzy

Run tests:

  • $ yarn test or $ npm test

Or specify the test that you want to run:

  • $ yarn test — model-client.test.js

With npm:

  • $ npm test — model-client.test.js

4. Document your changes

Add supporting documentation for your code.

5. Transpile the code

  • $ yarn build or $ npm run-script build

6. Send a pull request

Add and commit your changes:

  • git add .

  • $ git commit "A descriptive message"

Push your branch to GitHub:

  • $ git push origin my-new-awesome-feature

Roadmap

  • Wider API coverage (custom models, accounting, audit, etc).

  • [Maybe] Add retry logic for possibly transient issues.

  • Fetch model list errors.

Support

Use GitHub to report bugs and send feature requests.
Reach out to https://www.modzy.com/support/ for support requests.