Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
haskell-gargantext
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Grégoire Locqueville
haskell-gargantext
Commits
edfce2a2
Commit
edfce2a2
authored
Jul 24, 2023
by
Alexandre Delanoë
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Guidelines reading, modification and approval
parent
2288ee34
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
20 additions
and
5 deletions
+20
-5
DEVELOPER_GUIDELINES.md
DEVELOPER_GUIDELINES.md
+20
-5
No files found.
DEVELOPER_GUIDELINES.md
View file @
edfce2a2
...
...
@@ -31,6 +31,7 @@ here we mean that there should be some common driving principles which should ul
project being developed in a uniform way. In other words, there should be a clear process shared between
all developers about how to:
-
How to code in a collaborative way;
-
Propose and implement new features;
-
Report problems and write good bug reports;
-
Write tests (when, how, why);
...
...
@@ -40,6 +41,8 @@ The rest of the document try to answer all those questions.
## Glossary
-
GIT: _Git_ is a distributed version control system
-
MR: _Merge Request_; usually called "Pull Request" in the GitHub work, is an
event that takes place in software development when a contributor/developer
is ready to begin the process of merging new code changes with the main
...
...
@@ -54,6 +57,20 @@ The rest of the document try to answer all those questions.
The following is a non-exhaustive list of the development guidelines.
### Main working Branches
3 main branches are used in the distributed version control system (Git) of GarganText:
-
_dev_ branch for latest development
-
_testing_ branch for testing by beta tester
-
_stable_ branch for production only
Accordingly _dev_ commits are then merged into _testing_ then into
_stable_
if and only if the steps of this guideline are respected.
For development, please add the number of the issue in the branch you
are working on. For instance if you work on the issue with number #507,
use the following branch: dev-507-some-keywords-here
### Keep the issue tracker clean.
**
Guideline: periodically scan the issue tracker for issues which are no longer relevant or are now
...
...
@@ -214,11 +231,9 @@ Ideally, we could have the following process, divided in 4 phases:
We have presented a comprehensive overview on the set of best practices we should put in place within
Gargantext to make sure the project thrives, keeps growing and succeeds.
Reviewed and approved by:
-
Alfredo Di Napoli
-
???
## Revisions and certification
## Revisions
-
To review and agree with these guidelines, read it eventually improve
it and commit a change as signature.
2023-07-10: Initial version of this document
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment