Skip to content

Sync-in · Sovereign platform for file storage, sharing, synchronization, and collaboration.

chore(docs): merge and streamline CONTRIBUTING.md and DEVELOPMENT.md for clarity and simplicity

johaven4cb7f1620692
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ca926044..b6b3ea40 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,58 +1,157 @@
-# Contribution Guide for Sync-in
+# Contributing to Sync-in
-Welcome to **Sync-in**!
+We appreciate your contributions and efforts in making this project better.
+Before you contribute, please read the following guidelines to ensure a smooth collaboration.
-We appreciate your contributions and efforts in making this project better.
+## Code of Conduct
-Before you contribute, please read the following guidelines to ensure a smooth collaboration.
+All contributors must follow our [Code of Conduct](CODE_OF_CONDUCT.md) to ensure a friendly and inclusive environment.
-## 1. Contributor License Agreement (CLA)
+## How to Contribute
-🛡️ **No CLA Required to Use the Project**
-You’re free to use, modify, fork, and redistribute Sync-in under the AGPL v3 license — no agreement needed for that.
+### Reporting Issues & Suggesting Features
-✍️ **CLA Required to Contribute**
-If you wish to contribute (e.g., by opening a pull request), you must agree to our [Contributor License Agreement (CLA)](CLA.md).
+#### Bugs
-The CLA ensures that:
-- Your contribution remains open source
-- The project can also be offered under a commercial license
-- And you won’t need to be contacted again for permission in the future
+- Check existing issues before opening a new one.
+- Include detailed steps, logs, and screenshots when possible.
-If you do not agree with its terms, please refrain from contributing code.
+#### Feature Requests
----
+- Describe the problem the feature solves.
+- Provide use cases and, if possible, implementation suggestions.
-## 2. How to Contribute
+### Submitting Pull Requests
-### 🛠 Process
-- Understand the project’s goals, technical direction, and contribution practices.
+- Open an issue before submitting any pull request for a new feature or bug fix to avoid duplicate work, ensure alignment with the project’s goals,
+ and prevent wasted effort.
+- All pull requests must target the main branch, following the GitHub Flow model with continuous deployment.
- Make sure your work fits with the existing architecture, code style, and documentation standards.
- All contributions must comply with the [CLA](CLA.md).
+- Contributions are made under the [AGPL-3.0 license](LICENSE), the same license used by the project.
-### 🧪 Code Quality
-- Write clean, maintainable, and documented code.
-- Keep documentation in sync with your changes.
-- Add or update tests as needed to preserve stability.
+#### Submission Guidelines
----
+- Keep pull requests small and focused; avoid addressing multiple unrelated issues in a single PR.
+- Ensure all CI checks pass before submitting (linting, type checking, tests, and build).
+- Reference the related issue number in the PR description when applicable.
+- Include tests and update documentation as needed when introducing new features.
+- The PR author is responsible for resolving merge conflicts.
+- Use the [Conventional Commits specification](https://www.conventionalcommits.org/) for commit messages; pull requests are squashed on merge.
-## 3. Reporting Issues & Suggesting Features
+#### Branching
-### 🐛 Bugs
-- Check existing issues before opening a new one.
-- Include detailed steps, logs, and screenshots when possible.
+- **Main**: Production branch; all pull requests must target `main`.
+- **Feature branches**: Create a dedicated branch per feature or fix and submit a PR to `main`.
-### 🌟 Feature Requests
-- Describe the problem the feature solves.
-- Provide use cases and, if possible, implementation suggestions.
+## Development Setup
----
+You will need the following on your system:
-## 4. Code of Conduct
+- **Git**
+- **Node.js with npm**
+- **Database server** (mariadb)
+- **Docker** (optional but highly recommended)
-All contributors must follow our [Code of Conduct](CODE_OF_CONDUCT.md) to ensure a friendly and inclusive environment.
+## Project Structure
+
+The project uses npm workspaces to manage a monorepo with two main workspaces: `backend` and `frontend`.
+This structure enables shared tooling, coordinated builds, and simplified dependency management.
+
+| Workspace | Path | Technology | Purpose |
+|:----------|:---------:|:-----------------|:----------------------------------------|
+| Root | / | npm workspaces | Monorepo orchestration, shared scripts |
+| Backend | /backend | NestJS + Fastify | API server, business logic, data access |
+| Frontend | /frontend | Angular | User interface, client-side logic |
+
+## Setup Instructions
+
+### Clone the repo
+
+```
+git clone [email protected]:Sync-in/server.git
+cd server
+```
+
+### Run the database server
+
+Quick and simple example with docker:
+
+```
+sudo docker run -it -e MARIADB_DATABASE=database -e MARIADB_ROOT_PASSWORD=MySQLRootPassword -p 3306:3306 mariadb:11
+```
+
+### Create and edit your environment file
+
+```
+cp environment/environment.dist.yaml environment/environment.yaml
+```
+
+> [!CAUTION]
+> The `mysql.url` in the `environment.yaml` should match the mariadb credentials and
+> the `applications.files.dataPath` path should be writable.
+
+### Install dependencies and build the backend
+
+```
+npm ci
+npm -w backend run build
+```
+
+> [!TIP]
+> Building the backend once is useful to generate the script used in the next step (in the `dist` directory).
+
+### Init the database and create the admin user
+
+```
+npx drizzle-kit migrate --config=backend/src/infrastructure/database/configuration.ts
+node dist/server/infrastructure/database/scripts/create-user.js --role admin --login admin --password admin
+```
+
+### Build the frontend (dev mode)
+
+```
+npm -w frontend run build:dev
+```
+
+### Start the backend (dev mode)
+
+```
+npm -w backend run start:dev
+```
+
+**Default endpoint is `http://localhost:8080`, you should be able to login with `admin`:`admin`**
+
+**Happy coding!**
+
+## Useful Scripts
+
+### In the root workspace
+
+- `npm run test` run unit tests
+- `npm run lint` code linting
+- `npm run docker:build` build the Docker image
+
+## Development Guidelines
+
+- Always write/review tests for new features and bug fixes
+- Follow code style rules (`eslint.config.mjs`, `.prettierrc`)
+- Prefer clear naming and documentation within your code
+- Document significant architectural changes and updates
+
+## Troubleshooting
+
+- **Backend:** Check API logs for errors. Use your browser to test endpoints.
+- **Frontend:** Use Angular DevTools for debugging. Check browser console for runtime errors.
+- Make sure both the server and the database are running.
+
+## Useful Links
+
+- [NestJS Documentation](https://docs.nestjs.com)
+- [Angular Documentation](https://angular.dev)
+- [Node.js Documentation](https://nodejs.org/)
+- [TypeScript Handbook](https://www.typescriptlang.org/docs/)
---
-_Thanks again for helping make **Sync-in** better! 🚀_
\ No newline at end of file
+_Thanks again for helping make **Sync-in** better! 🚀_
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
deleted file mode 100644
index 6d7eca87..00000000
--- a/DEVELOPMENT.md
+++ /dev/null
@@ -1,108 +0,0 @@
-# Developer Guide for Sync-in
-
-## Prerequisites
-
-Before anything, please refer to the [Contribution Guide for Sync-in](CONTRIBUTING.md).
-
-You will need the following on your system:
-
-- **Git**
-- **Node.js with npm**
-- **Database server** (mariadb)
-- **Docker** (optional but highly recommended)
-
-## Project Structure
-
-The project uses npm workspaces to manage a monorepo with two main workspaces: `backend` and `frontend`.
-This structure enables shared tooling, coordinated builds, and simplified dependency management.
-
-| Workspace | Path | Technology | Purpose |
-|:----------|:---------:|:-----------------|:----------------------------------------|
-| Root | / | npm workspaces | Monorepo orchestration, shared scripts |
-| Backend | /backend | NestJS + Fastify | API server, business logic, data access |
-| Frontend | /frontend | Angular | User interface, client-side logic |
-
-## Setup Instructions
-
-### Clone the repo
-
-```
-git clone [email protected]:Sync-in/server.git
-cd server
-```
-
-### Run the database server
-
-Quick and simple example with docker:
-```
-sudo docker run -it -e MARIADB_DATABASE=database -e MARIADB_ROOT_PASSWORD=MySQLRootPassword -p 3306:3306 mariadb:11
-```
-
-### Create and edit your environment file
-```
-cp environment/environment.dist.yaml environment/environment.yaml
-```
-
-> [!CAUTION]
-> The `mysql.url` in the `environment.yaml` should match the mariadb credentials and
-> the `applications.files.dataPath` path should be writable.
-
-### Install dependencies and build the backend
-
-```
-npm ci
-npm -w backend run build
-```
-
-> [!TIP]
-> Building the backend once is useful to generate the script used in the next step (in the `dist` directory).
-
-
-### Init the database and create the admin user
-
-```
-npx drizzle-kit migrate --config=backend/src/infrastructure/database/configuration.ts
-node dist/server/infrastructure/database/scripts/create-user.js --role admin --login admin --password admin
-```
-
-### Build the frontend (dev mode)
-```
-npm -w frontend run build:dev
-```
-
-### Start the backend (dev mode)
-
-```
-npm -w backend run start:dev
-```
-**Default endpoint is `http://localhost:8080`, you should be able to login with `admin`:`admin`**
-
-**Happy coding!**
-
-## Useful Scripts
-
-### In the root workspace
-
-- `npm run test` run unit tests
-- `npm run lint` code linting
-- `npm run docker:build` build the Docker image
-
-## Development Guidelines
-
-- Always write/review tests for new features and bug fixes
-- Follow code style rules (`eslint.config.mjs`, `.prettierrc`)
-- Prefer clear naming and documentation within your code
-- Document significant architectural changes and updates
-
-## Troubleshooting
-
-- **Backend:** Check API logs for errors. Use your browser to test endpoints.
-- **Frontend:** Use Angular DevTools for debugging. Check browser console for runtime errors.
-- Make sure both the server and the database are running.
-
-## Useful Links
-
-- [NestJS Documentation](https://docs.nestjs.com)
-- [Angular Documentation](https://angular.dev)
-- [Node.js Documentation](https://nodejs.org/)
-- [TypeScript Handbook](https://www.typescriptlang.org/docs/)