Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create CONTRIBUTING.md #19

Merged
merged 2 commits into from
Jan 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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!
2 changes: 2 additions & 0 deletions pull-request-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading