From e8d2136ec466bc3744d5ccc015be0b3791435e03 Mon Sep 17 00:00:00 2001 From: Lucca <35308900+Lucca-C@users.noreply.github.com> Date: Mon, 22 Jan 2024 14:17:06 +0000 Subject: [PATCH 1/2] Create CONTRIBUTING.md --- CONTRIBUTING.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..014d9f4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Contributing to [Project Name] + +## Introduction +Thank you for considering contributing to [Project Name]. This document outlines the process for contributions. + +## How to Contribute +- Clone the repository. Branches should be [dev, FE/, BE/, API/] in order to be recognised by the workflow automation. E.g.: FE/login-page or BE/updating-databse. +- If you've added code, update the documentation accordingly. +- Ensure your code adheres to the coding standards specified. + +## Pull Requests +- Fill out the provided PR template with all required details. +- Link the PR to an issue. +- PR must be reviewed and merged by a teammate. + +## Reporting Bugs +- Use the issue tracker to report bugs. +- Include a clear description and as much relevant information as possible. + +## Feature Requests +- Use the issue tracker to submit feature requests. +- Clearly describe the feature and its potential benefits. + + +Thank you for your contributions! From 7d32fcfed580dc5037d08f6989ff39a454aa3455 Mon Sep 17 00:00:00 2001 From: Lucca <35308900+Lucca-C@users.noreply.github.com> Date: Mon, 22 Jan 2024 14:23:22 +0000 Subject: [PATCH 2/2] Update pull-request-template.md --- pull-request-template.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/pull-request-template.md b/pull-request-template.md index 5c834e3..85a5d25 100644 --- a/pull-request-template.md +++ b/pull-request-template.md @@ -8,6 +8,8 @@ assignees: ## Pull Request Overview #### Brief Description: Summary of changes and their purpose. +#### Issue Number: + #### Related User Story: Link to the user story or issue this PR addresses. ## Code Changes