Skip to content

Commit e23e99a

Browse files
author
Mika Hämäläinen
committed
🤣
1 parent 2de0ff0 commit e23e99a

File tree

4 files changed

+220
-76
lines changed

4 files changed

+220
-76
lines changed

‎CODE_OF_CONDUCT.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for Mika. 🤷🏼‍♂️
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to creating a positive environment
12+
include:
13+
14+
* Using welcoming and inclusive language towards Mika
15+
* Being respectful of Mika's viewpoints and experiences
16+
* Gracefully accepting constructive criticism -> No criticism, only positive thoughts 😇
17+
* Focusing on what is best for Mika
18+
* Showing empathy towards Mika
19+
20+
Examples of unacceptable behavior by participants include:
21+
22+
* Trolling, insulting/derogatory comments, and personal or political attacks
23+
* Public or private harassment
24+
* Publishing others' private information, such as a physical or electronic address, without explicit permission (wtf?)
25+
* Other conduct which could reasonably be considered inappropriate in a professional setting. Remeber, anything can be considered offensive in the modern world. 👍 I retain my right to get upset.
26+
* Opening issues on behalf of a company that is going to benefit from Mika's hard work
27+
28+
NB. Mika is always right and gets to decide what is acceptable and unacceptable
29+
30+
## Your Responsibilities
31+
32+
It is within your responsibilities to cite the paper describing UralicNLP whenever possible. 🤩 And shove money into Mika's pockets if you use UralicNLP in commercial applications.
33+
34+
## Scope
35+
36+
This Code of Conduct applies both within project spaces and in public spaces
37+
when an individual is representing the project or its community. Examples of
38+
representing a project or community include using an official project e-mail
39+
address, posting via an official social media account, or acting as an appointed
40+
representative at an online or offline event. Representation of a project may be
41+
further defined and clarified by project maintainers.
42+
43+
## Enforcement
44+
45+
Instances of abusive, harassing, or otherwise unacceptable behavior (like not citing me) may be
46+
reported by contacting Mika at [email protected]. All
47+
complaints will be reviewed and investigated and might result in a response that
48+
is deemed necessary and appropriate to the circumstances, but mostly will result in drama and overreacting. The project team is
49+
obligated to ~~maintain confidentiality~~ gossip with regard to the reporter of an incident.
50+
Further details of specific enforcement policies may be posted separately.
51+
52+
53+
## Attribution
54+
55+
This Code of Conduct is a fixed version of the [Contributor Covenant][homepage], version 1.4,
56+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

‎CONTRIBUTING.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# How to contribute to UralicNLP
2+
3+
## Reporting a bug
4+
5+
Before you report a bug, make sure you are using the latest version of
6+
- UralicNLP *pip install -U uralicNLP*
7+
- [VISL CG](https://mikalikes.men/how-to-install-visl-cg3-on-mac-windows-and-linux/)
8+
- Language models *uralicApi.download(language)*
9+
10+
Open up an issue on GitHub
11+
12+
## Fixing a bug
13+
14+
If you have found a bug, feel free to fix it and make a pull request. Give detailed information on what was fixed and how.
15+
16+
## New features
17+
18+
For requesting new features, open up an issue on GitHub. If you want to help in adding a new feature, you can also contact me directly mika.hamalainen📧helsinki.fi
19+
20+
## Adding new languages
21+
22+
If you have your FSTs and CGs distributed on GitHub with documented build scripts, I can add them to our nightly build system and they will be updated automatically. Just send me an email to [email protected]
23+
24+
If your files are not available on GitHub, compile them and name them accordingly to Giellatekno naming conventions.
25+
26+
- generator-gt-norm.hfstol (required)
27+
- generator-gt-desc.hfstol
28+
- generator-dict-gt-norm.hfstol
29+
- analyser-gt-norm.hfstol
30+
- analyser-gt-desc.hfstol (required)
31+
- disambiguator.cg3
32+
- metadata.json (required)
33+
34+
Send the files to me by email.
35+
36+
## Making model information more accurate
37+
38+
Every language distributed through akusanat.com has *metadata.json* file. This file contains information about the authors of the FSTs and CGs. However, as most of the tools are from Giellatekno and the AUTHORS and LICENSE contain more often than not \_\_FIXME\_\_ placeholder, this information is mostly missing. If you would like to help in making this information more accurate, feel free to send me a more complete metadata.json by [email protected]
39+
40+
An example of metadata.json
41+
42+
{
43+
"license": "CC BY",
44+
"authors": ["Mr Author"],
45+
"cite": "Mr Author (2019). A great publication. In a great venue. pages 2-345",
46+
"website": "https://victorio.uit.no/langtech/trunk/langs/xyz/",
47+
"acknowledgements": ""
48+
}
49+
50+
NB. metadata.json can include other keys and subdictionaries as well. The sturcture is used mainly for printing out the information in a human readable format.
51+
52+

‎SECURITY.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
Only the latest version of uralicNLP is supported for security updates. On the other hand, I am trying to make changes as backwards compatible as possible so that the latest version should work with code using a prior version.
6+
7+
| Version | Supported |
8+
| ------- | ------------------ |
9+
| latest | :white_check_mark: |
10+
| old versions | :x: |
11+
12+
13+
## Reporting a Vulnerability
14+
15+
In order to report a vulnerability, you can either open an issue or send me an email to [email protected]. Please describe the vulnerability as clearly as possible with an example exploit. Feel free to patch the code and open up a pull request as well.

‎pom.xml‎

Lines changed: 97 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,85 +1,106 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22

33
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4-
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
5-
<modelVersion>4.0.0</modelVersion>
4+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
5+
<modelVersion>4.0.0</modelVersion>
66

7-
<groupId>com.rootroo</groupId>
8-
<artifactId>UralicNLP-java</artifactId>
9-
<version>1.0-SNAPSHOT</version>
7+
<groupId>com.rootroo</groupId>
8+
<artifactId>UralicNLP</artifactId>
9+
<version>1.0</version>
1010

11-
<name>UralicNLP-java</name>
12-
<!-- FIXME change it to the project's website -->
13-
<url>http://www.example.com</url>
11+
<name>UralicNLP</name>
12+
13+
<url>https://github.com/mikahama/uralicNLP-java</url>
14+
<description>>NLP tools (generation, analysis, lemmatization) for multiple languages: Finnish, Russian, German...</description>
15+
<organization>
16+
<name>Rootroo Ltd</name>
17+
<url>https://rootroo.com/</url>
18+
</organization>
19+
<properties>
20+
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
21+
<maven.compiler.source>1.7</maven.compiler.source>
22+
<maven.compiler.target>1.7</maven.compiler.target>
23+
</properties>
24+
25+
<licenses>
26+
<license>
27+
<name>CC BY-NC-ND 4.0</name>
28+
<url>https://creativecommons.org/licenses/by-nc-nd/4.0/legalcode</url>
29+
</license>
30+
</licenses>
1431

15-
<properties>
16-
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
17-
<maven.compiler.source>1.7</maven.compiler.source>
18-
<maven.compiler.target>1.7</maven.compiler.target>
19-
</properties>
32+
<developers>
33+
<developer>
34+
<name>Mika Hämäläinen</name>
35+
<email>[email protected]</email>
36+
<url>https://mikakalevi.com</url>
37+
<organization>Rootroo Ltd</organization>
38+
<organizationUrl>https://rootroo.com/</organizationUrl>
39+
</developer>
40+
</developers>
2041

21-
<dependencies>
22-
<dependency>
23-
<groupId>junit</groupId>
24-
<artifactId>junit</artifactId>
25-
<version>4.11</version>
26-
<scope>test</scope>
27-
</dependency>
28-
<dependency>
29-
<groupId>fi.seco</groupId>
30-
<artifactId>hfst</artifactId>
31-
<version>1.1.5</version>
32-
</dependency>
33-
<dependency>
34-
<groupId>me.tongfei</groupId>
35-
<artifactId>progressbar</artifactId>
36-
<version>0.5.5</version>
37-
</dependency>
38-
</dependencies>
42+
<dependencies>
43+
<dependency>
44+
<groupId>junit</groupId>
45+
<artifactId>junit</artifactId>
46+
<version>4.11</version>
47+
<scope>test</scope>
48+
</dependency>
49+
<dependency>
50+
<groupId>fi.seco</groupId>
51+
<artifactId>hfst</artifactId>
52+
<version>1.1.5</version>
53+
</dependency>
54+
<dependency>
55+
<groupId>me.tongfei</groupId>
56+
<artifactId>progressbar</artifactId>
57+
<version>0.5.5</version>
58+
</dependency>
59+
</dependencies>
3960

40-
<build>
41-
<pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
42-
<plugins>
43-
<!-- clean lifecycle, see https://maven.apache.org/ref/current/maven-core/lifecycles.html#clean_Lifecycle -->
44-
<plugin>
45-
<artifactId>maven-clean-plugin</artifactId>
46-
<version>3.1.0</version>
47-
</plugin>
48-
<!-- default lifecycle, jar packaging: see https://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_jar_packaging -->
49-
<plugin>
50-
<artifactId>maven-resources-plugin</artifactId>
51-
<version>3.0.2</version>
52-
</plugin>
53-
<plugin>
54-
<artifactId>maven-compiler-plugin</artifactId>
55-
<version>3.8.0</version>
56-
</plugin>
57-
<plugin>
58-
<artifactId>maven-surefire-plugin</artifactId>
59-
<version>2.22.1</version>
60-
</plugin>
61-
<plugin>
62-
<artifactId>maven-jar-plugin</artifactId>
63-
<version>3.0.2</version>
64-
</plugin>
65-
<plugin>
66-
<artifactId>maven-install-plugin</artifactId>
67-
<version>2.5.2</version>
68-
</plugin>
69-
<plugin>
70-
<artifactId>maven-deploy-plugin</artifactId>
71-
<version>2.8.2</version>
72-
</plugin>
73-
<!-- site lifecycle, see https://maven.apache.org/ref/current/maven-core/lifecycles.html#site_Lifecycle -->
74-
<plugin>
75-
<artifactId>maven-site-plugin</artifactId>
76-
<version>3.7.1</version>
77-
</plugin>
78-
<plugin>
79-
<artifactId>maven-project-info-reports-plugin</artifactId>
80-
<version>3.0.0</version>
81-
</plugin>
82-
</plugins>
83-
</pluginManagement>
84-
</build>
61+
<build>
62+
<pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
63+
<plugins>
64+
<!-- clean lifecycle, see https://maven.apache.org/ref/current/maven-core/lifecycles.html#clean_Lifecycle -->
65+
<plugin>
66+
<artifactId>maven-clean-plugin</artifactId>
67+
<version>3.1.0</version>
68+
</plugin>
69+
<!-- default lifecycle, jar packaging: see https://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_jar_packaging -->
70+
<plugin>
71+
<artifactId>maven-resources-plugin</artifactId>
72+
<version>3.0.2</version>
73+
</plugin>
74+
<plugin>
75+
<artifactId>maven-compiler-plugin</artifactId>
76+
<version>3.8.0</version>
77+
</plugin>
78+
<plugin>
79+
<artifactId>maven-surefire-plugin</artifactId>
80+
<version>2.22.1</version>
81+
</plugin>
82+
<plugin>
83+
<artifactId>maven-jar-plugin</artifactId>
84+
<version>3.0.2</version>
85+
</plugin>
86+
<plugin>
87+
<artifactId>maven-install-plugin</artifactId>
88+
<version>2.5.2</version>
89+
</plugin>
90+
<plugin>
91+
<artifactId>maven-deploy-plugin</artifactId>
92+
<version>2.8.2</version>
93+
</plugin>
94+
<!-- site lifecycle, see https://maven.apache.org/ref/current/maven-core/lifecycles.html#site_Lifecycle -->
95+
<plugin>
96+
<artifactId>maven-site-plugin</artifactId>
97+
<version>3.7.1</version>
98+
</plugin>
99+
<plugin>
100+
<artifactId>maven-project-info-reports-plugin</artifactId>
101+
<version>3.0.0</version>
102+
</plugin>
103+
</plugins>
104+
</pluginManagement>
105+
</build>
85106
</project>

0 commit comments

Comments
 (0)