Skip to content

Commit 660a236

Browse files
committed
Update docs
1 parent 346012e commit 660a236

File tree

3 files changed

+57
-1
lines changed

3 files changed

+57
-1
lines changed

CONTRIBUTING.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Contributing to Processing Collaborative Editor
2+
3+
We welcome contributions to the Processing Collaborative Editor project! This document outlines the process for contributing to the repository through pull requests.
4+
5+
## Getting Started
6+
7+
1. Fork the repository on GitHub.
8+
2. Clone your fork locally:
9+
```
10+
git clone https://github.com/your-username/processing-collaborative-editor.git
11+
```
12+
3. Create a new branch for your feature or bug fix:
13+
```
14+
git checkout -b feature/your-feature-name
15+
```
16+
17+
## Making Changes
18+
19+
1. Make your changes in the new branch.
20+
2. Commit your changes with a clear and descriptive commit message:
21+
```
22+
git commit -m "Add feature: your feature description"
23+
```
24+
3. Push your changes to your fork on GitHub:
25+
```
26+
git push origin feature/your-feature-name
27+
```
28+
29+
## Creating a Pull Request
30+
31+
1. Go to the original repository on GitHub.
32+
2. Click on "Pull requests" and then the "New pull request" button.
33+
3. Click "compare across forks" and select your fork and branch.
34+
4. Review the changes and click "Create pull request".
35+
5. Fill out the pull request template with a clear title and description of your changes.
36+
6. Submit the pull request.
37+
38+
## Pull Request Guidelines
39+
40+
- Ensure your code follows the project's coding standards and style guidelines.
41+
- Include tests for new features or bug fixes.
42+
- Update documentation if necessary.
43+
- Make sure all tests pass before submitting the pull request.
44+
- Keep pull requests focused on a single feature or bug fix.
45+
46+
## Code Review Process
47+
48+
1. Maintainers will review your pull request.
49+
2. They may request changes or ask questions.
50+
3. Make any necessary updates to your branch and push the changes.
51+
4. Once approved, a maintainer will merge your pull request.
52+
53+
Thank you for contributing to the Processing Collaborative Editor project!

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,5 +33,8 @@ This project is a prototype for a new collaborative code editor designed for the
3333
- `npm run make:linux`: Packages the app for Linux using Electron Forge
3434
- `npm run sign_processing`: Signs the Processing library for notarization (macOS builds only). This script needs to be run only once, when packaging the app for the first time.
3535

36+
## Websocket Server
37+
The server code for the WebSocket server is available in the [PCE-Server](https://github.com/doradocodes/pce-server) repository.
38+
3639
## License
3740
This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "Proccessing-Collaborative-Editor",
33
"productName": "Processing Collaborative Editor",
4-
"version": "1.0.3",
4+
"version": "1.0.4",
55
"description": "Collaborative code editor for Processing",
66
"main": "main.js",
77
"scripts": {

0 commit comments

Comments
 (0)