Skip to content

Update CONTRIBUTING.md #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Chilledson merged 1 commit into from
Apr 9, 2025
Merged

Update CONTRIBUTING.md #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 2 additions & 38 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,41 +1,5 @@
# 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.
We are currently not taking contributions for this project. If you experience an issue please contact our support team at [[email protected]](mailto:[email protected]).

For customer support Please contact our support team at [[email protected]](mailto:[email protected])

## Local development

```shell
# 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](https://help.github.com/articles/using-pull-requests) with a clear title and description.
Feature requests/suggestions can be raised through our [suggestions board](https://suggestions.tebex.io/).