From fa009102ebfba5e0c5457c2bd063be36cd33eab2 Mon Sep 17 00:00:00 2001
From: Lucas Rayan <l.rayanguerra@gmail.com>
Date: Mon, 23 Mar 2026 19:01:04 -0300
Subject: [PATCH] docs: add CONTRIBUTING.md for JOSS compliance

---
 CONTRIBUTING.md | 91 +++++++++++++++++++++++++++++++++++++++++++++++++
 README.en.md    |  2 +-
 README.md       |  2 +-
 3 files changed, 93 insertions(+), 2 deletions(-)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..4962a7a
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,91 @@
+# Contributing to Process Scheduler Simulator (PSS)
+
+First of all, thank you for considering contributing to the Process Scheduler Simulator! It's people like you that make open-source software such a great community to learn, inspire, and create.
+
+This document provides guidelines and instructions for contributing to this project, in accordance with the Journal of Open Source Software (JOSS) requirements.
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+This section guides you through submitting a bug report for PSS. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
+
+If you find a bug, please create an issue on GitHub and include:
+- A clear and descriptive title.
+- Exact steps to reproduce the problem.
+- What you expected to happen, and what actually happened.
+- Screenshots or console logs if applicable.
+- Operating system and browser version.
+
+### Suggesting Enhancements
+
+This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality.
+
+To suggest an enhancement, open a new issue and include:
+- A clear and descriptive title.
+- A detailed description of the proposed functionality.
+- Why this enhancement would be useful to most users.
+- Any potential alternatives you have considered.
+
+### Setting up the Development Environment
+
+To contribute code, you'll need to set up the project locally.
+
+#### Prerequisites
+- [Node.js](https://nodejs.org/) (Version 20 or higher recommended)
+- npm (Version 10 or higher)
+
+#### Installation Steps
+
+1. **Fork the repository** on GitHub.
+2. **Clone your fork** locally:
+   ```bash
+   git clone https://github.com/YOUR_USERNAME/pss.git
+   cd pss
+   ```
+3. **Install dependencies**:
+   ```bash
+   npm install
+   ```
+4. **Start the development server**:
+   ```bash
+   npm run dev
+   ```
+   The application will be available at `http://localhost:5173`.
+
+### Testing
+
+PSS uses Vitest for testing. Before submitting any changes, ensure that all tests pass:
+
+```bash
+# Run unit tests
+npm test
+
+# Run tests with coverage report
+npm run test:coverage
+```
+
+If you add a new feature, please include appropriate tests covering the new functionality.
+
+### Submitting a Pull Request
+
+1. Create a new branch for your feature or bugfix:
+   ```bash
+   git checkout -b feature/my-awesome-feature
+   ```
+2. Make your coding changes.
+3. Commit your changes with clear, descriptive commit messages:
+   ```bash
+   git commit -m "feat: add awesome new feature"
+   ```
+4. Push your branch to your fork on GitHub:
+   ```bash
+   git push origin feature/my-awesome-feature
+   ```
+5. Open a Pull Request from your fork to the `main` branch of the original PSS repository. Include a detailed description of your changes and link any related issues.
+
+## Need Help?
+
+If you have questions about how to contribute or how to use the software, please open an Issue with the `question` label.
+
+Thank you for contributing!
diff --git a/README.en.md b/README.en.md
index 7feb87e..f6a7ec5 100644
--- a/README.en.md
+++ b/README.en.md
@@ -199,7 +199,7 @@ Tests cover the simulation engine, all scheduling algorithms, and metrics comput
 
 ## 🤝 Contributing
 
-Contributions are welcome! Feel free to open an [issue](https://github.com/lucasrguerra/pss/issues) or submit a Pull Request.
+Contributions are welcome! Please read our [CONTRIBUTING.md](./CONTRIBUTING.md) guide for details on our code of conduct, and the process for submitting Pull Requests to us.
 
 ---
 
diff --git a/README.md b/README.md
index f6cd8d8..31fa3c5 100644
--- a/README.md
+++ b/README.md
@@ -197,7 +197,7 @@ Os testes cobrem a engine de simulação, todos os algoritmos de escalonamento,
 
 ## 🤝 Contribuindo
 
-Contribuições são bem-vindas! Sinta-se livre para abrir uma [issue](https://github.com/lucasrguerra/pss/issues) ou enviar um Pull Request.
+Contribuições são bem-vindas! Por favor, consulte nosso guia em [CONTRIBUTING.md](./CONTRIBUTING.md) para obter detalhes sobre como configurar o ambiente de desenvolvimento, reportar bugs ou enviar um Pull Request.
 
 ---