Skip to content

Commit cb64af1

Browse files
aochoaeaochoae
authored
Merge pull request #5 from aochoae/chore/README
chore: general update
2 parents 7fcb46f + 490c770 commit cb64af1

File tree

3 files changed

+164
-165
lines changed

3 files changed

+164
-165
lines changed

‎.editorconfig‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,16 @@ root = true
33

44
# Unix-style newlines with a newline ending every file
55
[*]
6+
charset = utf-8
67
end_of_line = lf
8+
indent_style = space
79
insert_final_newline = true
8-
9-
# Set default charset
10-
[*]
11-
charset = utf-8
10+
trim_trailing_whitespace = true
1211

1312
# 4 space indentation
1413
[*.java]
15-
indent_style = space
1614
indent_size = 4
15+
16+
# 2 space indentation
17+
[*.xml]
18+
indent_size = 2

‎README.md‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,14 @@
22

33
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=aochoae_checkdigit-algorithms&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=aochoae_checkdigit-algorithms)
44

5+
A check digit algorithm works by adding an extra digit, called the check digit, which is calculated from the other digits in the number using a mathematical formula. These algorithms help catch common mistakes like mistyped, missing, or transposed digits.
6+
57
Algorithms:
68

79
* Damm algorithm
810
* Luhn algorithm
911
* Verhoeff algorithm
1012

11-
Documentation
12-
13-
* [Wiki](https://github.com/aochoae/checkdigit-algorithms/wiki)
14-
1513
## Getting started
1614

1715
We need to create a Java file to contain the following code:
@@ -21,9 +19,9 @@ We need to create a Java file to contain the following code:
2119
import io.github.aochoae.checkdigit.LuhnCheckDigit;
2220

2321
public class App {
24-
22+
2523
public static void main(String args[]) {
26-
24+
2725
LuhnCheckDigit checkDigit = new LuhnCheckDigit();
2826

2927
System.out.println(checkDigit.generate("4872148"));

‎pom.xml‎

Lines changed: 153 additions & 154 deletions
Original file line numberDiff line numberDiff line change
@@ -1,157 +1,156 @@
1-
21
<project xmlns="http://maven.apache.org/POM/4.0.0"
3-
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4-
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
2+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
54

6-
<modelVersion>4.0.0</modelVersion>
7-
<groupId>io.github.aochoae</groupId>
8-
<artifactId>checkdigit-algorithms</artifactId>
9-
<packaging>jar</packaging>
10-
<version>2.1.2</version>
11-
<name>checkdigit-algorithms</name>
12-
<description>Damm, Luhn and Verhoeff algorithms</description>
13-
<url>https://github.com/aochoae/checkdigit-algorithms</url>
14-
<developers>
15-
<developer>
16-
<name>Luis A. Ochoa</name>
17-
<url>https://github.com/aochoae</url>
18-
<roles>
19-
<role>developer</role>
20-
</roles>
21-
</developer>
22-
</developers>
23-
<licenses>
24-
<license>
25-
<name>The Apache License, Version 2.0</name>
26-
<url>https://www.apache.org/licenses/LICENSE-2.0.txt</url>
27-
</license>
28-
</licenses>
29-
<scm>
30-
<connection>scm:git:git://github.com/aochoae/checkdigit-algorithms.git</connection>
31-
<developerConnection>scm:git:ssh://github.com:aochoae/checkdigit-algorithms.git</developerConnection>
32-
<url>https://github.com/aochoae/checkdigit-algorithms/tree/main</url>
33-
</scm>
34-
<properties>
35-
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
36-
<maven.compiler.source>1.8</maven.compiler.source>
37-
<maven.compiler.target>1.8</maven.compiler.target>
38-
</properties>
39-
<dependencies>
40-
<dependency>
41-
<groupId>org.junit.jupiter</groupId>
42-
<artifactId>junit-jupiter</artifactId>
43-
<version>5.11.4</version>
44-
<scope>test</scope>
45-
</dependency>
46-
</dependencies>
47-
<build>
48-
<plugins>
49-
<plugin>
50-
<groupId>org.apache.maven.plugins</groupId>
51-
<artifactId>maven-surefire-plugin</artifactId>
52-
<version>3.0.0-M5</version>
53-
</plugin>
54-
<plugin>
55-
<groupId>org.jacoco</groupId>
56-
<artifactId>jacoco-maven-plugin</artifactId>
57-
<version>0.8.12</version>
58-
<executions>
59-
<execution>
60-
<id>prepare-agent</id>
61-
<goals>
62-
<goal>prepare-agent</goal>
63-
</goals>
64-
</execution>
65-
<execution>
66-
<id>jacoco-report</id>
67-
<phase>test</phase>
68-
<goals>
69-
<goal>report</goal>
70-
</goals>
71-
<configuration>
72-
<formats>
73-
<format>XML</format>
74-
<format>HTML</format>
75-
</formats>
76-
</configuration>
77-
</execution>
78-
</executions>
79-
</plugin>
80-
<plugin>
81-
<groupId>org.apache.maven.plugins</groupId>
82-
<artifactId>maven-source-plugin</artifactId>
83-
<version>2.2.1</version>
84-
<configuration>
85-
<archive>
86-
<manifest>
87-
<addDefaultImplementationEntries>true</addDefaultImplementationEntries>
88-
<addDefaultSpecificationEntries>true</addDefaultSpecificationEntries>
89-
</manifest>
90-
<manifestEntries>
91-
<Automatic-Module-Name>io.github.aochoae.checkdigit</Automatic-Module-Name>
92-
</manifestEntries>
93-
</archive>
94-
</configuration>
95-
<executions>
96-
<execution>
97-
<id>attach-sources</id>
98-
<goals>
99-
<goal>jar-no-fork</goal>
100-
</goals>
101-
</execution>
102-
</executions>
103-
</plugin>
104-
<plugin>
105-
<groupId>org.apache.maven.plugins</groupId>
106-
<artifactId>maven-javadoc-plugin</artifactId>
107-
<version>3.4.0</version>
108-
<configuration>
109-
<source>11</source>
110-
</configuration>
111-
<executions>
112-
<execution>
113-
<id>attach-javadocs</id>
114-
<goals>
115-
<goal>jar</goal>
116-
</goals>
117-
</execution>
118-
</executions>
119-
</plugin>
120-
<plugin>
121-
<groupId>org.apache.maven.plugins</groupId>
122-
<artifactId>maven-gpg-plugin</artifactId>
123-
<version>1.5</version>
124-
<executions>
125-
<execution>
126-
<id>sign-artifacts</id>
127-
<phase>verify</phase>
128-
<goals>
129-
<goal>sign</goal>
130-
</goals>
131-
</execution>
132-
</executions>
133-
</plugin>
134-
<plugin>
135-
<groupId>org.sonatype.plugins</groupId>
136-
<artifactId>nexus-staging-maven-plugin</artifactId>
137-
<version>1.6.13</version>
138-
<extensions>true</extensions>
139-
<configuration>
140-
<serverId>ossrh</serverId>
141-
<nexusUrl>https://s01.oss.sonatype.org/</nexusUrl>
142-
<autoReleaseAfterClose>true</autoReleaseAfterClose>
143-
</configuration>
144-
</plugin>
145-
</plugins>
146-
</build>
147-
<distributionManagement>
148-
<snapshotRepository>
149-
<id>ossrh</id>
150-
<url>https://s01.oss.sonatype.org/content/repositories/snapshots</url>
151-
</snapshotRepository>
152-
<repository>
153-
<id>ossrh</id>
154-
<url>https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/</url>
155-
</repository>
156-
</distributionManagement>
5+
<modelVersion>4.0.0</modelVersion>
6+
<groupId>io.github.aochoae</groupId>
7+
<artifactId>checkdigit-algorithms</artifactId>
8+
<packaging>jar</packaging>
9+
<version>2.1.2</version>
10+
<name>checkdigit-algorithms</name>
11+
<description>Damm, Luhn and Verhoeff algorithms</description>
12+
<url>https://github.com/aochoae/checkdigit-algorithms</url>
13+
<developers>
14+
<developer>
15+
<name>Luis A. Ochoa</name>
16+
<url>https://github.com/aochoae</url>
17+
<roles>
18+
<role>developer</role>
19+
</roles>
20+
</developer>
21+
</developers>
22+
<licenses>
23+
<license>
24+
<name>The Apache License, Version 2.0</name>
25+
<url>https://www.apache.org/licenses/LICENSE-2.0.txt</url>
26+
</license>
27+
</licenses>
28+
<scm>
29+
<connection>scm:git:git://github.com/aochoae/checkdigit-algorithms.git</connection>
30+
<developerConnection>scm:git:ssh://github.com:aochoae/checkdigit-algorithms.git</developerConnection>
31+
<url>https://github.com/aochoae/checkdigit-algorithms/tree/main</url>
32+
</scm>
33+
<properties>
34+
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
35+
<maven.compiler.source>1.8</maven.compiler.source>
36+
<maven.compiler.target>1.8</maven.compiler.target>
37+
</properties>
38+
<dependencies>
39+
<dependency>
40+
<groupId>org.junit.jupiter</groupId>
41+
<artifactId>junit-jupiter</artifactId>
42+
<version>5.11.4</version>
43+
<scope>test</scope>
44+
</dependency>
45+
</dependencies>
46+
<build>
47+
<plugins>
48+
<plugin>
49+
<groupId>org.apache.maven.plugins</groupId>
50+
<artifactId>maven-surefire-plugin</artifactId>
51+
<version>3.0.0-M5</version>
52+
</plugin>
53+
<plugin>
54+
<groupId>org.jacoco</groupId>
55+
<artifactId>jacoco-maven-plugin</artifactId>
56+
<version>0.8.12</version>
57+
<executions>
58+
<execution>
59+
<id>prepare-agent</id>
60+
<goals>
61+
<goal>prepare-agent</goal>
62+
</goals>
63+
</execution>
64+
<execution>
65+
<id>jacoco-report</id>
66+
<phase>test</phase>
67+
<goals>
68+
<goal>report</goal>
69+
</goals>
70+
<configuration>
71+
<formats>
72+
<format>XML</format>
73+
<format>HTML</format>
74+
</formats>
75+
</configuration>
76+
</execution>
77+
</executions>
78+
</plugin>
79+
<plugin>
80+
<groupId>org.apache.maven.plugins</groupId>
81+
<artifactId>maven-source-plugin</artifactId>
82+
<version>2.2.1</version>
83+
<configuration>
84+
<archive>
85+
<manifest>
86+
<addDefaultImplementationEntries>true</addDefaultImplementationEntries>
87+
<addDefaultSpecificationEntries>true</addDefaultSpecificationEntries>
88+
</manifest>
89+
<manifestEntries>
90+
<Automatic-Module-Name>io.github.aochoae.checkdigit</Automatic-Module-Name>
91+
</manifestEntries>
92+
</archive>
93+
</configuration>
94+
<executions>
95+
<execution>
96+
<id>attach-sources</id>
97+
<goals>
98+
<goal>jar-no-fork</goal>
99+
</goals>
100+
</execution>
101+
</executions>
102+
</plugin>
103+
<plugin>
104+
<groupId>org.apache.maven.plugins</groupId>
105+
<artifactId>maven-javadoc-plugin</artifactId>
106+
<version>3.4.0</version>
107+
<configuration>
108+
<source>11</source>
109+
</configuration>
110+
<executions>
111+
<execution>
112+
<id>attach-javadocs</id>
113+
<goals>
114+
<goal>jar</goal>
115+
</goals>
116+
</execution>
117+
</executions>
118+
</plugin>
119+
<plugin>
120+
<groupId>org.apache.maven.plugins</groupId>
121+
<artifactId>maven-gpg-plugin</artifactId>
122+
<version>1.5</version>
123+
<executions>
124+
<execution>
125+
<id>sign-artifacts</id>
126+
<phase>verify</phase>
127+
<goals>
128+
<goal>sign</goal>
129+
</goals>
130+
</execution>
131+
</executions>
132+
</plugin>
133+
<plugin>
134+
<groupId>org.sonatype.plugins</groupId>
135+
<artifactId>nexus-staging-maven-plugin</artifactId>
136+
<version>1.6.13</version>
137+
<extensions>true</extensions>
138+
<configuration>
139+
<serverId>ossrh</serverId>
140+
<nexusUrl>https://s01.oss.sonatype.org/</nexusUrl>
141+
<autoReleaseAfterClose>true</autoReleaseAfterClose>
142+
</configuration>
143+
</plugin>
144+
</plugins>
145+
</build>
146+
<distributionManagement>
147+
<snapshotRepository>
148+
<id>ossrh</id>
149+
<url>https://s01.oss.sonatype.org/content/repositories/snapshots</url>
150+
</snapshotRepository>
151+
<repository>
152+
<id>ossrh</id>
153+
<url>https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/</url>
154+
</repository>
155+
</distributionManagement>
157156
</project>

0 commit comments

Comments
 (0)