Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (39 loc) · 3.79 KB

CONTRIBUTING.md

File metadata and controls

67 lines (39 loc) · 3.79 KB
Raw

Contributing Guide

If you like to work on this project, this guide is made for you. First of all, I thank you for investing your time into my project. The following guide gives you some instruction and informations about the project structure, setting up the project on your local machine, opening issues and creating a pull request.

Getting Started

Project structure

PitManager uses a monorepo stucture. Therefore, all neccessary files and folders are available in this project.

  • /app - Folder for the windows application (Rust, Tauri, React and TypeScript).
  • /server - Folder for the server that provides the backend.

NOTE: Be aware that this folder structure might change or gets extended

Setup on your local machine

Requirements

NOTE: As the application is using the Windows API, you will not be able to run the app itself with a Mac or Linux PC.

As we use Rust and Tauri you need to install Rust and Cargo. It is also neccessary to install pnpm as I use it for this project.

  • $ git clone https://github.com/RobDeFlop/PitManager
  • $ cd PitManager
  • $ pnpm i

After installing all neccessary dependencies you are able to run:

  • $ pnpm app dev

to launch the app in development mode

If you are having issues ensure you are using the following versions of Rust and Node:

  • Rust version: 1.60.0
  • Node version: 17

Issues

Create a new issue

If you find an issue with the repository or have a feature request with PitManager, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using GitHub's issue feature on the repository.

Solve an issue

You like to contribute to the project? Scan throught the existing issues to find one that interests you. If you are new to open-source projects, you can use the label filter on the issue page.

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

  • Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a team member will review your proposal. We may ask questions or request for additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations! Once your PR is merged, your contributions will be included in the next release of the application.

Credits

This CONTRIBUTING.md file was modelled after the github/docs CONTRIBUTING.md file, and I appreciate the work of the original author.