Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

41 lines (28 loc) · 1.42 KB

Contributing Guidelines

We welcome everyone to contribute towards the Tebex Project to help create better and more stable applications. You are free to contribute and raise pull requests. The Tebex team will review the proposed changes and, if appropriate, merge the the changes into our code.

For customer support Please contact our support team at [email protected]

Local development

# Clone the repo
git clone [email protected]:MY_FORK/Tebex.js.git

# Move into the directory
cd Tebex.js

# Add the upstream repo
git remote add upstream [email protected]:tebexio/Tebex.js.git

# Get the latest upstream changes
git pull upstream

# Install dependencies
npm install

# Run dev environment
npm run start

# Build for project (files output in dist)
npm run build

Making Changes

  1. Ensure that your changes adhere to the current coding conventions used in this project, this means using indentation, accurate comments etc.
  2. Ensure existing and new tests pass using npm test

Submitting Changes

  1. Commit your changes in logical chunks, i.e. keep your changes small per single commit with a clear description.
  2. Locally merge (or rebase) the upstream branch into your branch: git pull upstream && git merge.
  3. Push your topic branch up to your fork: git push origin <branch-name>.
  4. Open a Pull Request with a clear title and description.