contributing.md

🎯 Contribute to Open Source

Any contributions are welcome, encouraged, and valued. See the following information below for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for me as maintainer and smooth out the experience for all involved. The community looks forward to your contributions. 🎉✌✨

📋 Code of Conduct

This project and everyone participating in it is governed by the project's Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to opensource@warengonzaga.com.

💖 How to Contribute

There are many ways to contribute to this open source project. Any contributions are welcome and appreciated. Be sure to read the details of each section for you to start contributing.

🧬 Development

If you can write a code then create a pull request to this repo and I will review your code. Please consider to submit your pull request to the dev branch. I will auto reject if you submit your pull request to the main branch.

🔧 Setup

To install the CLI app in your working directory, you can run the following command:

yarn setup

OR

npm run setup

Run the command everytime you make changes to the code. This will build the project and install the CLI app in your working directory. So you can test it out using magicc command.

Important

When using the setup command please ensure you are using linux-based OS. This command will use commands tht are only available in linux-based OS. Such as rm -rf to delete the dist folder.

📖 Documentation

(coming soon)

🐞 Reporting Bugs

For any security bugs or issues, please read the security policy.

---

💻 with ❤️ by Waren Gonzaga and Him 🙏