Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
14 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,24 +1,25 @@ | ||
| # How to Contribute to the AlaSQL project | ||
| # How to Contribute to AlaSQL | ||
|
|
||
| Thank you very much for your interest! AlaSQL project still has a lot of thing to be improved, and your help is very appreciated! | ||
| Thank you very much for your interest! AlaSQL has a lot of thing to be improved, and your help is very appreciated! | ||
|
|
||
| For you to edit the source please do the following: | ||
| For you to submit a pull request: | ||
|
|
||
| - Make sure you have Node, npm and git installed | ||
| - Make sure you have git, Node and yarn installed (`npm install -g yarn`) | ||
| - Fork the repo here on Github (button top right) | ||
| - Clone your forked repo and install dependencies `git clone https://github.com/MYUSERNAME/alasql/ --depth 1 && cd alasql && npm install` | ||
| - Clone your forked repo and install dependencies `git clone https://github.com/MYUSERNAME/alasql/ --depth 1 && cd alasql && yarn` | ||
| - Make sure you work with the develop branch `git checkout develop` | ||
| - Install dependencies with `npm install` | ||
| - Run tests to verify all is good `npm test` | ||
| - Add a test for the issue you have: Copy `test/test000.js` and replace `000` with a new number. | ||
| - Run tests to verify all is good `yarn test` | ||
| - Implement a test that reflects the issue. | ||
| - Run `npm test` to verify only the new test fails | ||
| - Add a new test file for the issue: Copy `test/test000.js` and replace `000` with a new number. Preferably the number of the issue you are solving. | ||
| - Run `yarn test` to verify only the new test fails | ||
| - Implement your contributions in `src/` | ||
| - Run `npm test` and verify all tests are OK | ||
| - Run `yarn test` and verify all tests are OK | ||
| - Format the souce with `yarn format` | ||
| - Commit changes to git and push to your forked repo | ||
| - Click "Create Pull-request" when looking at your forked repo on Github | ||
|
|
||
| _Please note that `npm test` will compile from `src/` and overwrite `dist/` before running all tests_ | ||
|
|
||
| If you would like to change the alasql.org website please make a PR to https://github.com/agershun/alasql-org | ||
| Please note that | ||
| - `npm test` will compile from `src/` and overwrite `dist/` before running all tests | ||
| - If you would like to change the alasql.org website please make a PR to https://github.com/agershun/alasql-org | ||
| - To help debug a problem you can see some advice on https://github.com/AlaSQL/alasql/issues/1415#issuecomment-1293335079 | ||
|
|