Thank you for your interest in contributing!
If you don't feel comfortable playing with the project's code, keep in mind that starting a conversation about a new feature or flagging a bug is already of great help! :)
Feel free to start a conversation if some questions you have are not answered below.
You can also check this tutorial as a resource.
The first step is to create an issue with a clear title and a description of the problem you encountered: https://github.com/nshiab/simple-data-analysis/issues
If you want to solve the problem yourself, explain what you have in mind and how you want to proceed.
Clone or fork the repository, create a new branch from your issue if relevant, and have fun!
The suggested workflow is to create tests in test/unit/ with the expected outputs and to add or modify classes and methods in src/.
Read the tests and the functions already present as inspirations. Do your best to write clear and understandable code.
Then, do your magic to pass the tests you created. It's a great way to stay focused and break down the tasks into small steps.
We use mocha for the tests, and the library is coded with TypeScript.
Here's how to run a specific test file with one or more tests in it:
npx mocha --require ts-node/register ./test/unit/methods/summarize.test.tsAnd here's how to run all mocha tests:
npm run testWhen committing your work, keep in mind that your messages will be public if your code gets merged into the main branch.
If you have any questions at any step, leave a comment on the relevant issue.
When all the steps above are dealt with, it's time for the final test, which runs all tests but also formats your files, runs a linter, builds the library and the docs (in a test folder).
npm run all-testsMake sure to correct any remaining problems, like linter warnings.
It's now time to share your wonderful work!
First, you need to make sure that your code is up-to-date. Some changes could have been pushed to the main branch while you worked on your things.
Pull the main branch latest version and merge it to your work. If you have conflicts, adapt your code to fix them.
And, now create a pull request! Explain what you did in your code and what issue you solved.
An experienced contributor will look at your proposition. They might ask questions and suggest modifications to your code.
When all questions are answered, and modifications are made, your code will be merged into the main branch and officially part of the library! Congrats!