Unitex/GramLab Core

Unitex/GramLab is an open source, cross-platform, multilingual, lexicon- and grammar-based corpus processing suite.

Unitex is the Natural Language Processing (NLP) engine of Unitex/GramLab.

How to Build

git clone https://github.com/UnitexGramLab/unitex-core
cd unitex-core/build
make DEBUG=yes UNITEXTOOLLOGGERONLY=yes

Contributing

We welcome everyone to contribute to improve the Unitex Core by forking this repository and sending pull requests with their changes. The recommended workflow to contribute is:

1. Fork us

2. Clone your fork locally

   git clone https://github.com/YOUR_GITHUB_USERNAME/unitex-core.git
   

3. Configure the upstream remote. To do this, add the remote location of the main unitex-core repository under the name upstream. This will allow you later to keep your fork up to date

   git remote add upstream git://github.com/UnitexGramLab/unitex-core.git
   

4. Create a local branch for your changes

   git checkout -b my-changes origin/master
   

   Use a short and descriptive name for your branch. If you are developing a new feature or enhancement, name your branch as feature/DESCRIPTIVE-NAME, if you are fixing a bug, name your branch as bugfix/N where N corresponds to an issue number, e.g. bugfix/5

5. For non-trivial changes, if it doesn't already exist, create a new issue

6. Edit files and compile your code following the How to Build instructions above

7. Execute ./unitex-core-test.sh -p1 -M1 to run non-regression and memory error detection tests. Note that is not necessary or even recommended to fork the unitex-core-tests repository. In this case, since you need only to run the unitex-core-test.sh script, make sure only your local repository is up-to-date by pulling the latest remote changes

8. Make sure git knows your name and email address, e.g.

   git config --global user.name "John Doe"
   git config --global user.email "john.doe@example.org"
   

9. Commit your code referring in the commit message the issue you worked on

10. Make sure your fork is up to date

    git checkout master
    git pull upstream master
    

11. Rebase your local branch

    git checkout my-changes
    git rebase master
    

12. Merge back into master

    git checkout master
    git merge my-changes
    

13. Push your changes to your remote repository on GitHub

    git push origin
    

14. Go to https://github.com/YOUR_GITHUB_USERNAME/unitex-core and Request a pull

15. Give a brief description and refer the issues in your pull request comment

16. Finally, if your are developing or improving a new functionality or module, you can, and should, contribute tests for it. To get further details check the unitex-core-tests repository

Documentation

User's Manual (in PDF format) is available in English and French (more translations are welcome). You can view and print them with Evince, downloadable here. The latest version of the User's Manual is accessible here.

Support

Support questions can be posted in the community support forum. Please feel free to submit any suggestions or requests for new features too. Some general advice about asking technical support questions can be found here.

Reporting Bugs

See the Bug Reporting Guide for information on how to report bugs.

Governance Model

Unitex/GramLab project decision-making is based on a community meritocratic process, anyone with an interest in it can join the community, contribute to the project design and participate in decisions. The Unitex/GramLab Governance Model describes how this participation takes place and how to set about earning merit within the project community.

Spelling

Unitex/GramLab is spelled with capitals "U" "G" and "L", and with everything else in lower case. Excepting the forward slash, do not put a space or any character between words. Only when the forward slash is not allowed, you can simply write “UnitexGramLab”.

It's common to refer to the Unitex/GramLab Core as "Unitex", and to the Unitex Project-oriented IDE as "GramLab". If you are mentioning the distribution suite (Core, IDE, Linguistic Resources and others bundled tools) always use "Unitex/GramLab".

License

This program is licensed under the GNU Lesser General Public License version 2.1. Contact unitex-devel@univ-mlv.fr for further inquiries.

--

Copyright (C) 2017 Université Paris-Est Marne-la-Vallée