Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
C
concepts-processing
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Package registry
Operate
Terraform modules
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
meldb
concepts-processing
Commits
5bac1766
Commit
5bac1766
authored
3 months ago
by
mjbonifa
Browse files
Options
Downloads
Patches
Plain Diff
docs: updated contributing.md
parent
a98788bc
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
contributing.md
+7
-6
7 additions, 6 deletions
contributing.md
with
7 additions
and
6 deletions
contributing.md
+
7
−
6
View file @
5bac1766
# 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 Releas
es
##
Branch
es
### 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)`
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment