Contributing

Getting Started

In this guide, you'll set up all you need to begin contributing to the project.

Step 0: Prerequisites

To compile and run the application, you need to have the following tools installed:

• .NET Core 8.0 SDK
• Node.js

On Linux

If you're using Linux, please follow the official guide to install .NET

Step 1: Repository

Firstly, you need to fork the repository, then clone it:

git clone https://github.com/<your_name>/MoodleAssistant.git

Then create another branch:

git checkout -b feature-name

After you made your changes, you can commit them and push:

git commit -am 'Add new feature' # commit
git push origin feature-name # push

Now, you can create a new Pull Request to propose your changes to this repository. ATTENTION: before making the pull request, make sure the app runs and run tests! See the steps below to know how to do it.

Step 2: Compile & Run the app

Then, you can run the following commands:

# Ensure you are in the project's root directory
cd MoodleAssistant # Go to the project folder
dotnet build # build the application
dotnet run # Run the application

You can also open the project or the solution and run with your preferred IDE/Editor (e.g. Visual Studio, Rider, ...).

Step 4: Test the application

You can test the application by running these commands:

# Ensure you are in the project's root directory
cd MoodleAssistant.Test
dotnet test

Step 5: End

Now you're all good to go to begin contributing! We recommend you to follow these steps:

• Learn more about MoodleAssistant at the Reference Page