Skip to content

Commit 2779996

Browse files
jeanphi-baconnaisjeanphi-baconnais
authored
✨ Prepare project for open source and add some adjustements (#55)
* ✨ Prepare project for opensource * 🐛 Adjust some items and replace top 3 by top 5
1 parent a8cfb74 commit 2779996

67 files changed

Lines changed: 845 additions & 683 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.env-example‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1-
%dev.github.token=<your-token>
2-
quarkus.langchain4j.mcp.github.environment.GITHUB_PERSONAL_ACCESS_TOKEN=<your-token>>
3-
GITHUB_TOKEN=<your-token>>
1+
# GitHub and GitLab tokens
2+
github.token=<your-github-token>
3+
gitlab.token=<your-gitlab-token>
4+
5+
# Organization to track
6+
organization.name=your-github-org
7+
organization.display-name=Your Organization Name

‎CONTRIBUTING.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contributing to Opensource Statistics
2+
3+
First off, thank you for considering contributing to Opensource Statistics! It's people like you that make the open source community such a great place.
4+
5+
## How Can I Contribute?
6+
7+
### Reporting Bugs
8+
This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
9+
10+
- **Check if the bug has already been reported** by searching the issues.
11+
- If you can't find an open issue addressing the problem, **open a new one**.
12+
- Use a clear and descriptive title.
13+
- Describe the exact steps which reproduce the problem in as many details as possible.
14+
15+
### Suggesting Enhancements
16+
This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality.
17+
18+
- **Check if the enhancement has already been suggested** by searching the issues.
19+
- **Open a new issue** and describe the enhancement you would like to see.
20+
21+
### Pull Requests
22+
- Fill in the pull request template (if available).
23+
- Ensure the PR description clearly describes the problem and solution.
24+
- Include the relevant issue number if applicable.
25+
- Make sure your code follows the project's coding style.
26+
- Update documentation as needed.
27+
28+
## Styleguides
29+
30+
### Git Commit Messages
31+
- Use the present tense ("Add feature" not "Added feature").
32+
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
33+
- Limit the first line to 72 characters or less.
34+
35+
## License
36+
By contributing, you agree that your contributions will be licensed under its MIT License.

‎README.md‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Opensource-statistiques 📊
1+
# Opensource Statistics 📊
22

33
![GitHub Release](https://img.shields.io/github/v/release/zenika-open-source/opensource-statistics)
44
![Quarkus](https://img.shields.io/badge/Quarkus-3.31.2-4695EB?logo=quarkus)
@@ -7,10 +7,12 @@
77

88
🚧 This project is in progress ...
99

10-
One objective of this project is to highlight Zenika members for their open source contributions.
10+
The objective of this project is to highlight an organization's members for their open source contributions.
1111

12-
To do this, data is scanned from both **GitHub** and **GitLab** and saved in a private Database on GCP.
13-
Data is used to find and list projects maintained or forked by Zenika Members, as well as their open source contributions.
12+
To do this, data is scanned from both **GitHub** and **GitLab** and saved in a database (e.g., GCP Firestore).
13+
Data is used to find and list projects maintained or forked by organization members, as well as their open source contributions.
14+
15+
The tracked organization is configurable in the application settings.
1416

1517
## 🗄️ Tech Stack
1618

@@ -23,11 +25,11 @@ Using:
2325
## 🌐 API
2426

2527
Some resources are available but only the first is in progress :
26-
- `/github/` to get information about Zenika members and organization from GitHub
27-
- `/gitlab/` to get information about Zenika members and organization from GitLab
28-
- `/members/` to get information from GCP database 🚧 not implemented
29-
- `/contributions/` to get information about contributions from GCP database 🚧 not implemented
30-
- `/workflow/` to get data and save them on GCP database
28+
- `/github/` to get information about organization members and organization from GitHub
29+
- `/gitlab/` to get information about organization members and organization from GitLab
30+
- `/members/` to get information from database 🚧 not implemented
31+
- `/contributions/` to get information about contributions from database 🚧 not implemented
32+
- `/workflow/` to get data and save them on database
3133

3234
## 🎨 UI
3335

‎pom.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
33
<modelVersion>4.0.0</modelVersion>
4-
<groupId>zenika.opensource</groupId>
4+
<groupId>oss.opensource-statistics</groupId>
55
<artifactId>oss-stats</artifactId>
66
<version>1.8.0</version>
77
<properties>

src/main/java/zenika/oss/stats/beans/CustomStatsContributionsUserByMonth.java renamed to src/main/java/fr/zenika/opensource/stats/beans/CustomStatsContributionsUserByMonth.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
package zenika.oss.stats.beans;
1+
package fr.zenika.opensource.stats.beans;
22

33
public class CustomStatsContributionsUserByMonth {
4-
4+
55
private int month;
66
private String monthLabel;
77
private int contributions;

src/main/java/zenika/oss/stats/beans/CustomStatsUser.java renamed to src/main/java/fr/zenika/opensource/stats/beans/CustomStatsUser.java

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
1-
package zenika.oss.stats.beans;
1+
package fr.zenika.opensource.stats.beans;
22

33
import java.util.List;
44

55
public class CustomStatsUser {
6-
6+
77
private String login;
88

99
private int year;
1010

1111
private List<CustomStatsContributionsUserByMonth> contributionsUserByMonths;
1212

13-
public CustomStatsUser(final String login, final int year, final List<CustomStatsContributionsUserByMonth> contributionsUserByMonths) {
13+
public CustomStatsUser(final String login, final int year,
14+
final List<CustomStatsContributionsUserByMonth> contributionsUserByMonths) {
1415

1516
this.login = login;
1617
this.year = year;
@@ -40,7 +41,8 @@ public List<CustomStatsContributionsUserByMonth> getContributionsUserByMonths()
4041
return contributionsUserByMonths;
4142
}
4243

43-
public void setContributionsUserByMonths(final List<CustomStatsContributionsUserByMonth> contributionsUserByMonths) {
44+
public void setContributionsUserByMonths(
45+
final List<CustomStatsContributionsUserByMonth> contributionsUserByMonths) {
4446

4547
this.contributionsUserByMonths = contributionsUserByMonths;
4648
}

src/main/java/zenika/oss/stats/beans/ZenikaMember.java renamed to src/main/java/fr/zenika/opensource/stats/beans/Member.java

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
package zenika.oss.stats.beans;
1+
package fr.zenika.opensource.stats.beans;
22

3-
import zenika.oss.stats.beans.github.GitHubMember;
4-
import zenika.oss.stats.beans.gitlab.GitLabMember;
3+
import fr.zenika.opensource.stats.beans.github.GitHubMember;
4+
import fr.zenika.opensource.stats.beans.gitlab.GitLabMember;
55

6-
7-
public class ZenikaMember {
6+
public class Member {
87

98
private String id;
109

src/main/java/zenika/oss/stats/beans/Project.java renamed to src/main/java/fr/zenika/opensource/stats/beans/Project.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package zenika.oss.stats.beans;
1+
package fr.zenika.opensource.stats.beans;
22

33
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
44

src/main/java/zenika/oss/stats/beans/gcp/StatsContribution.java renamed to src/main/java/fr/zenika/opensource/stats/beans/gcp/StatsContribution.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
package zenika.oss.stats.beans.gcp;
1+
package fr.zenika.opensource.stats.beans.gcp;
22

33
public class StatsContribution {
44

55
public String year;
66

77
public String month;
88

9-
public String idZenikaMember;
9+
public String idMember;
1010

1111
public String githubHandle;
1212

@@ -42,12 +42,12 @@ public void setMonth(String month) {
4242
this.month = month;
4343
}
4444

45-
public String getIdZenikaMember() {
46-
return idZenikaMember;
45+
public String getIdMember() {
46+
return idMember;
4747
}
4848

49-
public void setIdZenikaMember(String idZenikaMember) {
50-
this.idZenikaMember = idZenikaMember;
49+
public void setIdMember(String idMember) {
50+
this.idMember = idMember;
5151
}
5252

5353
public String getGithubHandle() {

src/main/java/zenika/oss/stats/beans/github/GitHubMember.java renamed to src/main/java/fr/zenika/opensource/stats/beans/github/GitHubMember.java

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
1-
package zenika.oss.stats.beans.github;
1+
package fr.zenika.opensource.stats.beans.github;
22

33
public class GitHubMember {
44
public String login;
55

66
public String id;
7-
7+
88
public String type;
9-
9+
1010
public String getId() {
1111

1212
return id;
1313
}
1414

15-
1615
public String getLogin() {
1716

1817
return login;

0 commit comments

Comments
 (0)