easy/splitwise-easy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
splitwise-easy/CONTRIBUTING.md

1.9 KiB
Raw Blame History

Contributing to Splitpro

If you plan to contribute to Splitpro, please take a moment to feel awesome ✨ People like you are what open source is about ♥. Any contributions, no matter how big or small, are highly appreciated.

Before getting started

  • Before jumping into a PR be sure to search existing PRs or issues for an open or closed item that relates to your submission.
  • Select an issue from here or create a new one
  • Consider the results from the discussion on the issue

Taking issues

Before taking an issue, ensure that:

  • The issue is clearly defined and understood
  • No one has been assigned to the issue
  • No one has expressed intention to work on it

You can then:

  1. Comment on the issue with your intention to work on it
  2. Begin work on the issue

Always feel free to ask questions or seek clarification on the issue.

Developing

The development branch is main. All pull requests should be made against this branch. If you need help getting started, send an email to koushik@ossapps.dev.

  1. Fork this repository to your own GitHub account and then clone it to your local device.
  2. Create a new branch:

  • Create a new branch (include the issue id and something readable):

    git checkout -b feat/doc-999-somefeature-that-rocks
  1. See the Developer Setup for more setup details.

Building

Note

Please ensure you can make a full production build before pushing code or creating PRs.

You can build the project with:

pnpm build