Skip to content

Update/contributing #129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
selgueti wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Update/contributing #129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
60bce1f
[fix #122] Fix syntax error in Makefile
selgueti May 5, 2022
cf6d2b2
Merge branch 'master' of https://github.com/UnitexGramLab/unitex-core
selgueti Jul 5, 2022
c320d3a
[feature #51] Add a parser for the configuration file
selgueti Jul 5, 2022
d30bd3d
Merge branch 'master' into master
martinec Aug 11, 2022
5d7a6d0
Update contribution guide
selgueti Sep 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,16 @@ with your changes. The recommended [workflow](http://rypress.com/tutorials/git/r

1. Create a local **branch** for your changes

If your new branch depends on a branch that has not yet been merged, use the following:

```
git checkout branch-not-yet-merged
git branch my-branch branch-not-yet-merged
```

Otherwise:
```
git checkout -b my-changes origin/master
git checkout -b my-branch origin/master
```

Use a short and descriptive name for your branch. If you are developing a new
Expand All @@ -40,6 +48,8 @@ with your changes. The recommended [workflow](http://rypress.com/tutorials/git/r

1. Edit the files and **compile** your code following the *How to Build* instructions

- Refrain from using new C++ libraries, so as not to limit the ability to compile code under architectures, platforms or other C/C++ compilers that are incompatible with them. (e.g. instead of vector use struct list_pointer)

1. Execute [`./unitex-core-test.sh -p1 -M1`](https://github.com/UnitexGramLab/unitex-core-tests#getting-started)
to run non-regression and memory error detection **tests**. Note that is not necessary or even
recommended to fork the [unitex-core-tests](https://github.com/UnitexGramLab/unitex-core-tests) repository.
Expand All @@ -54,6 +64,8 @@ with your changes. The recommended [workflow](http://rypress.com/tutorials/git/r
git config --global user.email "john.doe@example.org"
```

1. If changes made include new files, add them in files src/build/Unitex4_vs2019.*

1. **Commit** your code following the [Commit Message Guidelines](https://github.com/UnitexGramLab/unitex-doc-contributor-guidelines/blob/master/pages/05.guidelines/01.commits/docs.md)

1. Make sure your fork is **up to date**
Expand All @@ -70,13 +82,6 @@ with your changes. The recommended [workflow](http://rypress.com/tutorials/git/r
git rebase master
```

1. **Merge** back into master

```
git checkout master
git merge my-changes
```

1. **Push** your changes to your remote repository on GitHub

```
Expand Down
Loading