Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
91 lines (55 loc) · 4.2 KB

CONTRIBUTING.md

File metadata and controls

91 lines (55 loc) · 4.2 KB

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.

Adding a new locale

We are in the process of setting up WebPlate for automated GUI based locale adding. Please do not use it yet, but the process below will become much simpler soon!

If you speak a language that is missing here or spot some mistakes in the translations, feel free to submit a PR, not much coding knowledge required! The process involves copying the files in public/locales/en and creating a new folder with your locale. Then it is a matter of updating the values themselves and adding your locale in the config and client.

Before submitting a PR, please run the local environment and check that it looks alright in the UI. Also, by submitting a PR, you assume the role of a maintainer of the translation, as possibly no one else will be able to check it.

Adding a new currency rate provider

This is very straightforward and requires adding a new subclass in ./src/server/api/services/currencyRateService.ts. You basically need to define a method that given a currency pair and a date, returns the appropriate date. If the provider returns more currencies in one API call, you can also return more, as well as only return an intermediate currencies, the inherited methods will put it all together!

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, go to our GitHub Discussions.

  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.

Linting

This projects implements oxlint for linting. When developing please make sure to have an IDE integration enabled and watch out not to introduce new warnings. It is also nice to follow the boy scout rule and leave the code you modify with a little less warnings. Checks are enforced on CI for linting, formatting and typing, so run necessary checks before pushing.

Pre-commit Hooks

This project uses Husky and lint-staged to automatically run code quality checks before each commit:

  • Prettier: Automatically formats code according to the project's style guide
  • oxlint: Runs linting checks and automatically fixes issues where possible

The pre-commit hooks are automatically installed when you run pnpm install. If you need to manually set them up:

pnpm exec husky install

Bypassing pre-commit hooks

In rare cases where you need to bypass the pre-commit checks, you can use:

git commit --no-verify -m "your commit message"

Note: Only use --no-verify when absolutely necessary, as it skips important code quality checks.

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