Skip to content

Latest commit

 

History

History
73 lines (45 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

73 lines (45 loc) · 2.57 KB
Raw

Contributing

When it comes to open source, there are different ways you can contribute, all of which are valuable. Here's few guidelines that should help you as you prepare your contribution.

Table of Contents

Initial Steps

Before you start working on a contribution, please check the issues page. It's possible someone else is already working on something similar, or perhaps there is a reason that feature isn't implemented. The maintainers will point you in the right direction.

If you still have questions, please check the Discord

Development

The following steps will get you setup to contribute changes to this repo:

  • Fork the repo
  • Clone your forked repository: git clone [email protected]:{your_username}/en-croissant.git
  • Enter the en-croissant directory: cd en-croissant
  • Create a new branch off the master branch: git checkout -b your-feature-name
  • Install dependencies pnpm i
  • Open the code in your preferred IDE and contribute your changes

It is recommended take a look at the Commands and Extra Notes sections before starting.

Commands

pnpm i

  • Installs all dependencies

pnpm dev

  • Starts the app in development mode to see changes in real time

pnpm test

  • Runs all tests, generating a report

pnpm format

  • Formats the project according to the project guidelines

pnpm lint:fix

  • Lints the project according to the project guidelines

pnpm build

Submitting a Pull Request

  • Implement your contributions (see the Development section for more information)
  • Before submitting a PR, first build the app using pnpm tauri build -b none and check every feature you've contributed to.
  • Format and lint your code using pnpm format followed by pnpm lint:fix
  • Go to the comparison page and select the branch you just pushed in the compare: dropdown
  • Submit the new PR. The maintainers will follow up ASAP.

Extra Notes

The app uses the Rust language for interacting with the filesystem, chess engines and databases, and React with Vite (using TypeScript, of course) for displaying the GUI.

  • The Rust code can be found in src-tauri/src
  • The React code can be found in src