Skip to main content

Contributing

Suggesting helpers/features​

If you're using Bigodin and you found something that wasn't easy to template, we'd love to hear it from you! Open a feature request or a helper idea.

If you're confortable with Bigodin's code, you can also open a PR with the implementation of your feature after the issue is reviewed.

Reporting bugs​

If Bigodin didn't work as expected, please let us know by opening a bug report.

If you're confortable with Bigodin's code, you can also open a PR with a failing test expecting the behavior you want. If you're even more comfortable with the code, you can also open a PR with a fix for the bug.

Asking questions​

If something wasn't clear from the documentation, or if you have any questions, please open an issue, we're happy to help! Showing us what's not clear from the docs makes it easier for new users to get started.

After the issue is reviewed, feel free to open a PR updating the documentation.

Opening PRs​

If you find an Issue you'd like to address, please open a PR!

Cloning Bigodin​

First, clone the repository and install the dependencies:

git clone https://github.com/JPBM135/bigodin.git
cd bigodin
yarn install

Now you're ready to code! After changing anything, make sure the tests still pass:

yarn test

If you'd like to use your local version of Bigodin in your project, you can create a link with yarn. Inside your bigodin folder:

yarn link

...and inside the project you want to use it:

yarn link bigodin