Skip to content

Latest commit

 

History

History
77 lines (50 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

77 lines (50 loc) · 2.7 KB
Raw

Contributing to Robotics Academy Desktop

Welcome to the Robotics Academy Desktop project! We're excited to have you here and appreciate your interest in contributing. Whether you're a developer, designer, or just enthusiastic about robotics and education, there are many ways to contribute to our open-source project.

Table of Contents

Getting Started

Before you start contributing, please make sure you have reviewed our README to understand the project's goals and how it works.

Development Setup

To set up your development environment and get the Robotics Academy Desktop running locally, follow these steps:

  1. Fork the repository to your GitHub account.

  2. Clone your forked repository to your local machine:

    git clone https://github.com/your-username/RoboticsAcademy-Desktop.git

  3. Navigate to the project directory:

    cd RoboticsAcademy-Desktop

  4. Install project dependencies:

    npm install

  5. Start the application:

    npm run dev

  6. Make changes and test your code.

Issues

We use GitHub Issues to track tasks, bugs, enhancements, and other development-related discussions. If you find a bug, have a suggestion, or want to work on an existing issue, follow these steps:

  1. Check the existing issues to see if your issue or idea has already been discussed.
  2. If it hasn't been discussed, create a new issue with a clear title and description, including steps to reproduce if it's a bug.

Contributing Code

We welcome contributions from the community. To contribute code, follow these guidelines:

  1. Fork the repository.

  2. Create a new branch for your feature or bug fix:

    git checkout -b feature-name

  3. Write clean and well-documented code.

  4. Commit your changes with clear and concise commit messages.

  5. Push your branch to your forked repository.

  6. Create a pull request (PR) to the main repository's main branch.

We will review your PR as soon as possible. Please be patient and open to feedback.

Code of Conduct

We have adopted a Code of Conduct that we expect all contributors to adhere to. Please read it and ensure you understand the expected behavior within our community.