<commit_before># bridge

[![Build Status](https://travis-ci.org/Dezorganizacja/bridge.svg)](https://travis-ci.org/Dezorganizacja/bridge)

## Tools
* Java 8
* JavaFX
* JUnit 4

## Setup

### IntelliJ setup
1. Clone git repository `git clone <EMAIL>:Dezorganizacja/bridge.git`
2. Import maven project by clicking `File -> Import Project...` and selecting `bridge/pom.xml` file.
3. Run `com.dezorganizacja.bridge.Bridge` class.

### Shell setup

You can probably ignore these steps if you use proper IDE. :)

1. Clone git repository `git clone <EMAIL>:Dezorganizacja/bridge.git`
2. Compile project using `mvn package`
3. Run `java -jar target/Bridge.jar`

## Contributing

1. We use [Trello](https://trello.com/b/xIddxJPH/main) for tracking features (and bugs) and GitHub Pull Requests to handle code reviews.
2. `master` branch **must always** be stable, usable (i.e. code compiles, app starts...), and all automated **tests must pass**.
3. Each feature (or bug, refactor) requires a separate git branch
4. Code is incorporated (merged) into `master` branch only after 2 code reviews (yes, I actually mean it). You need an "OK" from your peer and one random person (preferably more experienced than you).
5. It's OK to spend a lot of time polishing your Pull Requests. It's much more productive to ease others' work, even if slows you down.
6. Make sure you are listed under "Authors" section of this file. :)
7. Once your branch is merged, delete it from GitHub

### Perfect feature/bugfix/pull request

Do one feature/bugfix at a time. Keep it small, but make sure the change makes sense on its own (smallest logical feature).

Never, ever, mix refactors, bug fixes, and features. Make sure bugfix or refactor is done first (preferably merged), and only then start working on your feature (on a new branch!).

Keep your commit messages small and logical. Make sure the name is descriptive and does not contain only one word like "fix".

**ALWAYS** test your code before creating a pull request. Write and run automated tests, verify manually that the application behaves correctly.

Be nice and patient.

Try to address others' concerns. If they have doubts, your code is not clear enough. Strive to change that.

### Language

* Code, comments in code, commit names - must be in English
* Pull Request titles - prefer English
* Pull Request descriptions and comments, Trello tasks - Polish
* other docs - prefer English

## Testing

No idea.

## Authors

* [<NAME>](http://swirski.name)
* <NAME>
* <NAME><commit_msg>add information about testing to the readme<commit_after># bridge

[![Build Status](https://travis-ci.org/Dezorganizacja/bridge.svg)](https://travis-ci.org/Dezorganizacja/bridge)

## Tools
* Java 8
* JavaFX
* JUnit 4

## Setup

### IntelliJ setup
1. Clone git repository `git clone git@github.com:Dezorganizacja/bridge.git`
2. Import maven project by clicking `File -> Import Project...` and selecting `bridge/pom.xml` file.
3. Run `com.dezorganizacja.bridge.Bridge` class.

### Shell setup

You can probably ignore these steps if you use proper IDE. :)

1. Clone git repository `git clone git@github.com:Dezorganizacja/bridge.git`
2. Compile project using `mvn package`
3. Run `java -jar target/Bridge.jar`

## Contributing

1. We use [Trello](https://trello.com/b/xIddxJPH/main) for tracking features (and bugs) and GitHub Pull Requests to handle code reviews.
2. `master` branch **must always** be stable, usable (i.e. code compiles, app starts...), and all automated **tests must pass**.
3. Each feature (or bug, refactor) requires a separate git branch
4. Code is incorporated (merged) into `master` branch only after 2 code reviews (yes, I actually mean it). You need an "OK" from your peer and one random person (preferably more experienced than you).
5. It's OK to spend a lot of time polishing your Pull Requests. It's much more productive to ease others' work, even if slows you down.
6. Make sure you are listed under "Authors" section of this file. :)
7. Once your branch is merged, delete it from GitHub

### Perfect feature/bugfix/pull request

Do one feature/bugfix at a time. Keep it small, but make sure the change makes sense on its own (smallest logical feature).

Never, ever, mix refactors, bug fixes, and features. Make sure bugfix or refactor is done first (preferably merged), and only then start working on your feature (on a new branch!).

Keep your commit messages small and logical. Make sure the name is descriptive and does not contain only one word like "fix".

**ALWAYS** test your code before creating a pull request. Write and run automated tests, verify manually that the application behaves correctly.

Be nice and patient.

Try to address others' concerns. If they have doubts, your code is not clear enough. Strive to change that.

### Language

* Code, comments in code, commit names - must be in English
* Pull Request titles - prefer English
* Pull Request descriptions and comments, Trello tasks - Polish
* other docs - prefer English

## Testing

### IntelliJ

1. Right-click the `src/test/java` directory in the Project tool window
2. Select Run 'All Tests'

### Shell

Tests are automatically run after running `mvn package`. To explicitly run tests execute
`mvn test` command.

## Authors

* [<NAME>](http://swirski.name)
* <NAME>
* <NAME>
{'fraction_non_alphanumeric': 0.0931723877781969, 'fraction_numerical': 0.006412674462466994, 'mean_word_length': 4.173658536585366, 'pattern_counts': {'":': 0, '<': 11, '<?xml version=': 0, '>': 13, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 2}, 'pii_count': 2, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '432140', 'n_tokens_mistral': 1540, 'n_tokens_neox': 1495, 'n_words': 744}