Skip to content

Commit 3b04089

Browse files
Create CONTRIBUTING.md for hackoctoberfest
1 parent 19c546f commit 3b04089

1 file changed

Lines changed: 76 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributing to Robotics Academy Desktop
2+
3+
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.
4+
5+
## Table of Contents
6+
7+
1. [Getting Started](#getting-started)
8+
2. [Development Setup](#development-setup)
9+
3. [Issues](#issues)
10+
4. [Contributing Code](#contributing-code)
11+
5. [Code of Conduct](#code-of-conduct)
12+
6. [License](#license)
13+
14+
## Getting Started
15+
16+
Before you start contributing, please make sure you have reviewed our [README](https://github.com/JdeRobot/RoboticsAcademy-Desktop) to understand the project's goals and how it works.
17+
18+
## Development Setup
19+
20+
To set up your development environment and get the Robotics Academy Desktop running locally, follow these steps:
21+
22+
1. Fork the repository to your GitHub account.
23+
2. Clone your forked repository to your local machine:
24+
25+
```bash
26+
git clone https://github.com/your-username/RoboticsAcademy-Desktop.git
27+
```
28+
29+
3. Navigate to the project directory:
30+
31+
```bash
32+
cd RoboticsAcademy-Desktop
33+
```
34+
35+
4. Install project dependencies:
36+
37+
```bash
38+
npm install
39+
```
40+
41+
5. Start the application:
42+
43+
```bash
44+
npm start
45+
```
46+
47+
6. Make changes and test your code.
48+
49+
## Issues
50+
51+
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:
52+
53+
1. Check the [existing issues](https://github.com/JdeRobot/RoboticsAcademy-Desktop/issues) to see if your issue or idea has already been discussed.
54+
2. If it hasn't been discussed, [create a new issue](https://github.com/JdeRobot/RoboticsAcademy-Desktop/issues/new) with a clear title and description, including steps to reproduce if it's a bug.
55+
56+
## Contributing Code
57+
58+
We welcome contributions from the community. To contribute code, follow these guidelines:
59+
60+
1. Fork the repository.
61+
2. Create a new branch for your feature or bug fix:
62+
63+
```bash
64+
git checkout -b feature-name
65+
```
66+
67+
3. Write clean and well-documented code.
68+
4. Commit your changes with clear and concise commit messages.
69+
5. Push your branch to your forked repository.
70+
6. Create a pull request (PR) to the main repository's `main` branch.
71+
72+
We will review your PR as soon as possible. Please be patient and open to feedback.
73+
74+
## Code of Conduct
75+
76+
We have adopted a [Code of Conduct](CODE_OF_CONDUCT.md) that we expect all contributors to adhere to. Please read it and ensure you understand the expected behavior within our community.

0 commit comments

Comments
 (0)