CONTRIBUTING.md

Foxify Contributor Guide

Before you start with this guide, we'd like to thank you for taking the time to help improve & move this project forward 🎖️

Table of Contents

• Source Contribution
  • Before you start!
  • Getting Started
• Financial Contribution
• Credits
  • Contributors
  • Sponsors
  • Backers

Source Contribution

Before you start!

Before you get started with implementing your awesome 🚀 ideas, make sure to check the to see if it is already being discussed/implemented.

If you don't see any relative issues, then create one yourself and try explaining what you'd like to see/do in this project.

This process will allow us and you to determine the need, willingness! and/or process to achieve your shared idea. The implementation will start after the said issue is finalized and moved out from the triage phase.

This process is in place to avoid putting unnecessary/duplicate time/effort delivering all kind of stuff within the scope of this project.

Getting Started

To get started please clone the repository and checkout the main branch.

• Firstly, install the dependencies:

pnpm i

• Implement the feature, bug fix, etc, based on the issue specification.

• Check your code styles and fix any issues (related to your code only):

pnpm lint

• Then, run the tests and fix any potential bugs:

pnpm test:coverage

Try to achieve the 100% reported code coverage on your code, at the very least. (100% reported code coverage does not guarantee that all possible scenarios are tested)

• Lastly, create a PR and link the issue.

Financial Contribution

We welcome financial contributions in full transparency on our open collective.

Credits

Contributors

This project exists thanks to all the people who contribute.

Made with contrib.rocks.

Sponsors

Support Foxify by becoming a sponsor. Your logo will show up here. [Become a sponsor]

Backers

Thanks to all Foxify backers! [Become a backer]