Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
88 lines (56 loc) · 2.62 KB

CONTRIBUTING.md

File metadata and controls

88 lines (56 loc) · 2.62 KB

I want to contribute! What should i do?

Thats awesome! There are many ways you can contribute to the Feliz project:

  1. 🏷️ Start by creating an issue of your planned changes. This allows us to discuss the changes before you start working on them and ensure that they are aligned with the project goals.
  2. 🛠️ Fork the repository and create a new branch for your changes.
    • Check out the section below to find the most important instructions for setting up your development environment.
  3. ✨ Make your changes and ensure that you follow the coding style and conventions used in the project. (Styling should be automatically applied by Fantomas if you use VS Code with Ionide)
  4. ✅ Write tests for your changes to ensure that they work as expected and do not introduce any regressions.
  5. 📚 Document your changes!

    • Every Feliz-.fsproj has a related "CHANGELOG" file. Add your changes following the instructions inside the file!

      Please use the following base structure for your changelog entries:

      <the-cool-and-awesome-changes-you-did> <#any-related-issue-or-pr-number> (by <@your-github-username>)

    • Write/Update documentation under ./docs!

  6. 📄 Create a pull request with a clear description of your changes and the issue it addresses.

Setting up your development environment

Requirements

  1. .NET SDK 10.0 or later
  2. Node.js 20 or later

Setup

  1. Clone the repository

  2. Install dependencies: dotnet run --project ./build/Build.fsproj setup.

    Alternatively, you can manually install the dependencies:

    • NPM dependencies:

      npm install

    • .NET dependencies:

      dotnet restore

    • .NET tools:

      dotnet tool restore

  3. Verify correct setup by running the tests dotnet run --project ./build/Build.fsproj test

  4. Ready! 🎉

Workflows

Feliz uses a f# build project to run common tasks such as testing. You can find the entrypoint for the build project under ./build/Build.fsproj.

Tip

On Windows you can also use .\build.cmd to run the build tasks instead of dotnet run --project ./build/Build.fsproj. On MacOS/Linux you can also use ./build.sh to run the build tasks instead of dotnet run --project ./build/Build.fsproj.

Testing

dotnet run --project ./build/Build.fsproj test

Run docs

  1. Go into docs folder:

    cd docs

  2. Start docs server:

    npm run start