Skip to content
Snippets Groups Projects
Commit 5bac1766 authored by mjbonifa's avatar mjbonifa
Browse files

docs: updated contributing.md

parent a98788bc
No related branches found
No related tags found
No related merge requests found
# Contributing - Development Guide
# Contributing
This document summaries the development guide for contributing to the ACMC project.
## Prerequisites
To install the ACMC package for development, ensure you have Python 3.9 or later installed.
......@@ -133,10 +135,9 @@ Upload to pypi using:
twine upload dist/acmc-<version>-py3-none-any.whl --username __token__ --password <your pypi token>
```
## GitLab Workflows
## Contributing
### GitLab Basic Workflow Overview
### Basic
1. Create an new issue in the [Issue Tracker](https://git.soton.ac.uk/meldb/concepts-processing/-/issues)
......@@ -170,7 +171,7 @@ You can also create a new branch in your local repo if it does not exist and it
If you make changes, ensure all tests pass and code formatting is correct before submitting a merge request.
## GitLab Workflow for Managing Releases
## Branches
### 1. Main Branch (`main`)
- Represents the stable production-ready code.
......@@ -216,7 +217,7 @@ If you make changes, ensure all tests pass and code formatting is correct before
- Deploy to production after approval.
- Requires authorization from a repository maintainer or admin before merging.
### Commit Message Guidelines
## Commit Message Guidelines
- Use clear and descriptive commit messages.
- Format: `<type>(<scope>): <description>`
- Example: `docs: git workflow documentation (#issue)`
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment