decaf's Core Module Contributing

Contributing

Hi there! I'm thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Contributions to this project are released to the public under the project's open source license.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

git clone https://github.com/decaf-ts/core.git
cd core
npm install
npm run build

npm run test:all

Note: We don't have any useful tests yet, contributions are welcome!

Fork and clone the repository
Configure and install the dependencies: npm install
Make sure the tests pass on your machine: npm run test:all
Create a new branch: git checkout -b my-branch-name. Relate the branch to an issue if possible
Make your change, add tests, add documentation, and make sure the tests still pass
Make sure to build and package before pushing: npm run prepare-release
Push to your fork and submit a pull request
Pat your self on the back and wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

Add lots of tests for new features.
Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
Write a good commit message.