Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
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
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
humanities
gargantext
Commits
1a02ad6e
Commit
1a02ad6e
authored
May 06, 2016
by
c24b
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Contribution guide
parent
ef4ba14a
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
48 additions
and
34 deletions
+48
-34
contribution.md
docs/contribution.md
+48
-34
No files found.
docs/contribution.md
View file @
1a02ad6e
#Contribution guide
*
A question or a problem? Ask the community
*
Sources
*
Tools
*
Contribution workflow: for contributions, bugs and features
*
Some examples of contributions
## Community
Need help? Ask the community
*
[
http://gargantext.org/about
](
http://gargantext.org/about
)
*
IRC Chat: (OFTC/FreeNode) #gargantex
## Source
Source are available throught XXX LICENSE
You can install Gargantext throught the
[
installation procedure
](
./install.md
)
##Tools
*
gogs
*
forge.iscpif.fr
*
server access
*
gargantext box
##Gargantex
*
Gargantex box install
(S.I.R.= Setup Install & Run procedures)
## Contributing: workflow procedure
Once you have installed and tested Gargantext
You
*
Architecture Overview
1.
Clone the stable release into your project
Note: The current stable release
<release
_branch
>
is: refactoring
Inside the repo, clone the reference branch and get the last changes:
git checkout
<ref
_branch
>
git pull
*
Database Schema Overview
It is highly recommended to create a generic branch on a stable release such as
git checkout -b
<username>
-
<release
_branch
>
git pull
*
Interface design Overview
##To do:
*
Docs
*
Interface deisgn
*
Parsers/scrapers
*
Computing
2.
Create your project on stable release
## How to contribute:
1.
Clone the repo
2.
Create a new branch
<username>
-refactoring
3.
Run the gargantext-box
4.
Code
5.
Test
6.
Commit
git checkout -b
<username>
-
<release
_branch
>
-
<project
_name
>
Do your modifications and commits as you want it:
git commit -m "foo/bar/1"
git commit -m "foo/bar/2"
git push
If you want to save your local change you can merge it into your generic branch
<username>
-
<release
_branch
>
git checkout
<username>
-
<release
_branch
>
git pull
git merge
<username>
-
<release
_branch
>
-
<project
_name
>
git commit -m "
[
Merge OK
]
comment"
### Exemple1: Adding a parser
*
create your new file cern.py into gargantex/scrapers/
*
reference into gargantex/scrapers/urls.py
add this line:
import scrapers.cern as cern
*
reference into gargantext/constants
```
# type 9
{ 'name': 'Cern',
'parser': CernParser,
'default_language': 'en',
},
```
*
add an APIKEY in gargantex/settings
##Technical Overview
*
Interface Overview
*
Database Schema Overview
*
Architecture Overview
### Exemple1: Adding a parser
### Exemple2: User Interface Design
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