-
Notifications
You must be signed in to change notification settings - Fork 143
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge commit '09645bee4cabb713b4055a963bf2deaf339b9f1f'
- Loading branch information
Showing
898 changed files
with
30,815 additions
and
25,344 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,168 @@ | ||
*/target/* | ||
#### joe made this: http://goel.io/joe | ||
|
||
#####=== Java ===##### | ||
|
||
*.class | ||
|
||
# Mobile Tools for Java (J2ME) | ||
.mtj.tmp/ | ||
|
||
# Package Files # | ||
*.jar | ||
*.war | ||
*.ear | ||
|
||
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml | ||
hs_err_pid* | ||
|
||
#####=== Maven ===##### | ||
|
||
target/ | ||
pom.xml.tag | ||
pom.xml.releaseBackup | ||
pom.xml.versionsBackup | ||
pom.xml.next | ||
release.properties | ||
|
||
#####=== JetBrains ===##### | ||
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm | ||
|
||
*.iml | ||
|
||
## Directory-based project format: | ||
.idea/ | ||
# if you remove the above rule, at least ignore the following: | ||
|
||
# User-specific stuff: | ||
# .idea/workspace.xml | ||
# .idea/tasks.xml | ||
# .idea/dictionaries | ||
|
||
# Sensitive or high-churn files: | ||
# .idea/dataSources.ids | ||
# .idea/dataSources.xml | ||
# .idea/sqlDataSources.xml | ||
# .idea/dynamic.xml | ||
# .idea/uiDesigner.xml | ||
|
||
# Gradle: | ||
# .idea/gradle.xml | ||
# .idea/libraries | ||
|
||
# Mongo Explorer plugin: | ||
# .idea/mongoSettings.xml | ||
|
||
## File-based project format: | ||
*.ipr | ||
*.ids | ||
*.iws | ||
choco.iws~ | ||
parser/src/fzn/choco.jar | ||
parser/src/fzn/fzn_choco | ||
*.jar | ||
parser/src/lib/* | ||
*.DS_Store | ||
*/dependency-reduced-pom.xml | ||
|
||
choco-parser/src/main/resources/mysql.properties | ||
choco-solver/src/test/resources/logback-test | ||
## Plugin-specific files: | ||
|
||
# IntelliJ | ||
out/ | ||
|
||
# mpeltonen/sbt-idea plugin | ||
.idea_modules/ | ||
|
||
# JIRA plugin | ||
atlassian-ide-plugin.xml | ||
|
||
# Crashlytics plugin (for Android Studio and IntelliJ) | ||
com_crashlytics_export_strings.xml | ||
crashlytics.properties | ||
crashlytics-build.properties | ||
|
||
#####=== Eclipse ===##### | ||
*.pydevproject | ||
.metadata | ||
.gradle | ||
bin/ | ||
tmp/ | ||
*.tmp | ||
*.bak | ||
*.swp | ||
*~.nib | ||
local.properties | ||
.settings/ | ||
.loadpath | ||
|
||
# External tool builders | ||
.externalToolBuilders/ | ||
|
||
# Locally stored "Eclipse launch configurations" | ||
*.launch | ||
|
||
# CDT-specific | ||
.cproject | ||
|
||
# PDT-specific | ||
.buildpath | ||
|
||
# sbteclipse plugin | ||
.target | ||
|
||
# TeXlipse plugin | ||
.texlipse | ||
|
||
#####=== NetBeans ===##### | ||
nbproject/private/ | ||
build/ | ||
nbbuild/ | ||
dist/ | ||
nbdist/ | ||
nbactions.xml | ||
nb-configuration.xml | ||
.nb-gradle/ | ||
|
||
#####=== OSX ===##### | ||
.DS_Store | ||
.AppleDouble | ||
.LSOverride | ||
|
||
# Icon must end with two \r | ||
Icon | ||
|
||
|
||
# Thumbnails | ||
._* | ||
|
||
# Files that might appear on external disk | ||
.Spotlight-V100 | ||
.Trashes | ||
|
||
# Directories potentially created on remote AFP share | ||
.AppleDB | ||
.AppleDesktop | ||
Network Trash Folder | ||
Temporary Items | ||
.apdisk | ||
|
||
#####=== Linux ===##### | ||
*~ | ||
|
||
# KDE directory preferences | ||
.directory | ||
|
||
# Linux trash folder which might appear on any partition or disk | ||
.Trash-* | ||
|
||
#####=== Windows ===##### | ||
# Windows image file caches | ||
Thumbs.db | ||
ehthumbs.db | ||
|
||
# Folder config file | ||
Desktop.ini | ||
|
||
# Recycle Bin used on file shares | ||
$RECYCLE.BIN/ | ||
|
||
# Windows Installer files | ||
*.cab | ||
*.msi | ||
*.msm | ||
*.msp | ||
|
||
# Windows shortcuts | ||
*.lnk | ||
|
||
choco-parser/src/chocofzn/fzn_choco.sh |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- This is the official list of the AUTHORS of Choco3 | ||
for copyright purposes. | ||
This file is distinct from the CONTRIBUTORS files. | ||
See the latter for an explanation. | ||
|
||
Names should be added to this file as | ||
Name or Organization <email address> | ||
The email address is not required for organizations. | ||
--> | ||
Jean-Guillaume Fages <[email protected]>, | ||
Xavier Lorca <[email protected]>, | ||
Narendra Jussien <[email protected]>, | ||
Charles Prud'homme <[email protected]> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,100 @@ | ||
# Contributing to Choco3 | ||
|
||
The developments are pushed on the develop branch, so this is the most up-to-date version of the code. | ||
As far as possible, the master branch is only updated twice or thrice a year, | ||
based on the following [Git branching model](http://nvie.com/posts/a-successful-git-branching-model/). | ||
|
||
## Using the issue tracker | ||
|
||
The issue tracker is the preferred channel for [bug reports](#bug), [feature requests](#feat) | ||
and [submitting pull requests](#pull). | ||
If you need a personal support request, use the [forum](http://choco-solver.org/?q=Forum), | ||
most support requests are answered very fast. | ||
|
||
|
||
<a name="bug"></a> | ||
## Bug reports | ||
|
||
Choco3 is a living library which is frequently modified, sometimes deeply. | ||
We do our best to track bugs in the [tracker](https://github.com/chocoteam/choco3/issues). | ||
But, it happens that a modification exhibit a bug or, simply, that we did not test the code enough. | ||
In that case: | ||
|
||
1. Search in [tracker](https://github.com/chocoteam/choco3/issues) to see if the bug has already been reported | ||
(do not forget to look for closed issues), and/or fixed; | ||
|
||
2. Isolate the problem, describe it and provide a [Minimal Working Example](https://en.wikipedia.org/wiki/Minimal_Working_Example). | ||
The [stackoverflow guidelines](http://stackoverflow.com/help/mcve) is a very good starting point. | ||
If possible, try to reproduce the bug on the develop branch | ||
and do not forget to indicate which version were used to reproduce the bug (release version or revision number). | ||
|
||
Doing so, we will endeavor to reproduce the bug and fix it as soon as possible in the develop branch. | ||
If the bug is critical, a release could be done in advance. | ||
|
||
<a name="feat"></a> | ||
## Feature requests | ||
|
||
Feature requests are welcome, we always appreciate having feedback. | ||
For your ideas to be considered, please give us as much details as possible, some practical cases are bonus. | ||
And if you feel like doing it by yourself, what about submitting a [pull request](#pull) ? | ||
|
||
|
||
|
||
<a name="pull"></a> | ||
## Pull requests | ||
|
||
Contributing to Choco3 is easy. | ||
|
||
0. Make sure you have the right to send any changes you make. If you do changes at work you may find your employer owns the patch not you. | ||
|
||
1. Fork Choco3 on https://github.com/chocoteam/choco3, | ||
|
||
2. Work with the source: Choco3 is maven-based project, easy to install on any IDEs, | ||
|
||
3. Add your features and test them, | ||
|
||
4. Send a pull request on Github. | ||
|
||
|
||
This is about code and documentation! | ||
|
||
### Code modification | ||
|
||
If you modify a class: | ||
|
||
- add your name and email to the list of authors in the file, we will maintain the | ||
global list of authors/contributors, | ||
|
||
- comment your modifications, | ||
|
||
- always test your changes (if you don't known what/how to test, contact us). | ||
|
||
|
||
If you create a new class: | ||
|
||
- reproduce the licence text like in any other classes already provided, | ||
|
||
- add your name and email address, we will maintain the global list of authors/contributors, | ||
|
||
- java-document and comment your code as much as possible, | ||
|
||
- always test your changes (if you don't known what/how to test, contact us). | ||
|
||
|
||
##### Tests | ||
|
||
We use TestNG as a testing framework. | ||
However, if you prefer JUnit, we will migrate the code in a second phase. | ||
|
||
The rules are: | ||
|
||
- prefer ten short tests instead of long one, | ||
|
||
- make sure the tests you add are deterministic, if not, make sure the seed can be set easily, | ||
|
||
|
||
### User guide improvement | ||
|
||
We use [sphinxdoc](http://sphinx-doc.org) to maintain and generate the documentation. | ||
Any help is appreciated: even if we are the best position to write the documentation, | ||
we need you to stand back and make good (better) choices. |
Oops, something went wrong.