From 8edc7d8fd9057781f926557dd3e7d867ee3f4dc3 Mon Sep 17 00:00:00 2001 From: Luis Eduardo Date: Mon, 3 Feb 2025 04:52:46 +0000 Subject: [PATCH] Update CONTRIBUTING.md and taskfile.yaml to enhance development guidelines and simplify task commands --- CONTRIBUTING.md | 37 +++++++++++++++++++++++++------------ taskfile.yaml | 10 ---------- 2 files changed, 25 insertions(+), 22 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3a10d3c..d2f3efd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,13 +2,21 @@ Thank you for your interest in contributing to the PG Back Web project! Please follow these guidelines to ensure smooth collaboration and consistent code quality. -### Main Branch Policy +## Open Source + +This project is completely open source, so before making a contribution make sure you agree with the license in the [LICENSE](LICENSE) file and that all your contributions are under the same license. + +This means that any contribution made to this project will be assumed to be made under the same license. + +### Main Branch Policy + - The **main branch** reflects the latest **stable release** of the project. - **No direct commits** should ever be made to the main branch. - All development work should happen in feature branches and merged via **Pull Requests (PRs)** into the **develop** branch. - The **develop branch** contains the latest code under active development. Once a new release is ready, the main branch will be updated by merging from the development branch. -### Development Workflow +### Development Workflow + 1. **Fork the repository** and create a feature branch from the `develop` branch. - Use descriptive names for your branches, e.g., `feature/add-new-endpoint` or `bugfix/fix-connection-issue`. @@ -22,25 +30,30 @@ Thank you for your interest in contributing to the PG Back Web project! Please f 6. Once approved, the changes will be merged into the `develop` branch. A merge into the `main` branch will only occur when releasing a new version. -### Project Dependencies -This project requires the following dependencies installed on your system: -- [**Taskfile**](https://taskfile.dev/) – Used to automate development tasks. +### Project Dependencies + +This project requires the following dependencies installed on your system: +- **VSCode** - To enter into the devcontainer - **Docker** – For containerized environments. - **Docker Compose** – To manage multi-container setups. -### How to Use Taskfile Commands +### Development process + +This project uses devcontainers to simplify the development, please refer to the following resources to learn more about devcontainers: + +- https://containers.dev +- https://code.visualstudio.com/docs/devcontainers/containers +- https://www.youtube.com/watch?v=SDa3v4Quj7Y + +### How to Use Taskfile Commands + - To see all available commands, run: ```bash task --list ``` -- The **primary command** for development is: - ```bash - task on - ``` - This command should be run from your **host environment** to start a local development server. +### Additional Notes -### Additional Notes - Always **write clear commit messages** that explain the purpose of your changes. - **Keep your fork up to date** with the latest changes from the `develop` branch. - Be respectful and follow the project’s code of conduct when interacting with other contributors. diff --git a/taskfile.yaml b/taskfile.yaml index 7c25fc4..94d225d 100644 --- a/taskfile.yaml +++ b/taskfile.yaml @@ -5,16 +5,6 @@ dotenv: [".env"] interval: 500ms tasks: - on: - desc: Start development environment, should be run from the host machine - cmds: - - docker compose -f ./docker/compose.dev.yaml up -d --build - - docker compose -f ./docker/compose.dev.yaml exec app /bin/bash - - off: - desc: Stop development environment, should be run from the host machine - cmd: docker compose -f ./docker/compose.dev.yaml down - dev: desc: Build and serve the project with hot reloading watch: true