Skip to content

Commit 0cd6332

Browse files
author
Kanishk Raj
authored
Add files via upload
1 parent 9ad906d commit 0cd6332

File tree

1 file changed

+129
-0
lines changed

1 file changed

+129
-0
lines changed

CONTRIBUTING.md

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
2+
# Contributing to SimpleScript
3+
4+
Thank you for considering contributing to **SimpleScript**! This project is an educational and developer-friendly scripting language built using JavaScript. It features a lexer, parser, and interpreter along with a fully interactive web interface.
5+
6+
We welcome contributions from everyone—whether you're a beginner or an experienced developer. Your help makes SimpleScript better for all users.
7+
8+
---
9+
10+
## Table of Contents
11+
12+
- [Getting Started](#getting-started)
13+
- [How to Contribute](#how-to-contribute)
14+
- [Project Structure](#project-structure)
15+
- [Coding Guidelines](#coding-guidelines)
16+
- [Pull Request Process](#pull-request-process)
17+
- [Feature Suggestions](#feature-suggestions)
18+
- [Reporting Bugs](#reporting-bugs)
19+
- [Community Standards](#community-standards)
20+
- [License](#license)
21+
22+
---
23+
24+
## Getting Started
25+
26+
1. **Fork the repository** to your GitHub account.
27+
2. **Clone your fork** locally:
28+
```bash
29+
git clone https://github.com/your-username/simple-script.git
30+
cd simple-script
31+
```
32+
3. **Install any dependencies** (if applicable):
33+
```bash
34+
npm install
35+
```
36+
4. **Start the development server**:
37+
```bash
38+
npm run dev
39+
```
40+
41+
---
42+
43+
## How to Contribute
44+
45+
There are several ways you can contribute to SimpleScript:
46+
47+
- Improve the **lexer**, **parser**, or **interpreter**
48+
- Add support for **new keywords, functions, or data types**
49+
- Improve or refactor the **frontend UI/UX**
50+
- Write **unit tests** or **example scripts**
51+
- Enhance or fix **documentation**
52+
- Report and fix **bugs**
53+
54+
---
55+
56+
## Project Structure
57+
58+
- `lexer/` – Token generation logic
59+
- `parser/` – Grammar and syntax rules
60+
- `interpreter/` – Execution logic
61+
- `web/` – HTML, CSS, and JavaScript interface
62+
- `docs/` – Language documentation and examples
63+
64+
---
65+
66+
## Coding Guidelines
67+
68+
- Follow consistent naming conventions
69+
- Keep functions small and focused
70+
- Comment complex logic for clarity
71+
- Write clean, readable code
72+
- Run tests and verify functionality before pushing
73+
74+
---
75+
76+
## Pull Request Process
77+
78+
1. Create a new branch:
79+
```bash
80+
git checkout -b feature/your-feature-name
81+
```
82+
2. Make your changes and commit them with meaningful messages.
83+
3. Push the branch to your forked repo:
84+
```bash
85+
git push origin feature/your-feature-name
86+
```
87+
4. Open a pull request with:
88+
- Clear title
89+
- Detailed description
90+
- Screenshots or test results if applicable
91+
92+
---
93+
94+
## Feature Suggestions
95+
96+
Want to see something added to SimpleScript? Open an issue labeled `enhancement` and describe your idea in detail.
97+
98+
---
99+
100+
## Reporting Bugs
101+
102+
If you find a bug, please:
103+
104+
1. Check if it’s already reported.
105+
2. Create a new issue with steps to reproduce.
106+
3. Include screenshots, logs, or error messages if possible.
107+
108+
---
109+
110+
## Community Standards
111+
112+
- Be respectful and constructive
113+
- Encourage beginners and help others learn
114+
- No harassment, discrimination, or spam
115+
116+
See our [Code of Conduct](CODE_OF_CONDUCT.md) for full details.
117+
118+
---
119+
120+
## License
121+
122+
SimpleScript is open-source and available under the MIT License.
123+
124+
---
125+
126+
Let’s build something amazing—together!
127+
128+
Happy Coding!
129+
— The SimpleScript Team

0 commit comments

Comments
 (0)