https://github.com/balanikas/github-repository-analysis
Analysis of public github repositories
https://github.com/balanikas/github-repository-analysis
dotnet github repository
Last synced: 7 months ago
JSON representation
Analysis of public github repositories
- Host: GitHub
- URL: https://github.com/balanikas/github-repository-analysis
- Owner: balanikas
- License: mit
- Created: 2022-11-09T14:16:59.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-03-20T18:09:18.000Z (almost 3 years ago)
- Last Synced: 2025-04-19T16:13:21.906Z (9 months ago)
- Topics: dotnet, github, repository
- Language: C#
- Homepage: https://githubrepositoryanalysis.com
- Size: 616 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Support: .github/SUPPORT.md
Awesome Lists containing this project
README
# Github Repository Analysis
Service that provides analysis and guidance for public github repositories.
- Do you already have a public github project you want to check?
- Do you plan to make a project public?
Then this is for you.
#### Status
[](https://github.com/balanikas/github-repository-analysis/actions/workflows/deploy-to-acr.yaml)
[](https://github.com/balanikas/github-repository-analysis/actions/workflows/codeql.yml)
#### Quality
[](https://sonarcloud.io/summary/new_code?id=balanikas_github-repository-analysis)
[](https://sonarcloud.io/summary/new_code?id=balanikas_github-repository-analysis)
[](https://sonarcloud.io/summary/new_code?id=balanikas_github-repository-analysis)
[](https://sonarcloud.io/summary/new_code?id=balanikas_github-repository-analysis)
[](https://sonarcloud.io/summary/new_code?id=balanikas_github-repository-analysis)
[](https://sonarcloud.io/summary/new_code?id=balanikas_github-repository-analysis)
[](https://sonarcloud.io/summary/new_code?id=balanikas_github-repository-analysis)
[](https://sonarcloud.io/summary/new_code?id=balanikas_github-repository-analysis)
[](https://sonarcloud.io/summary/new_code?id=balanikas_github-repository-analysis)
[](https://sonarcloud.io/summary/new_code?id=balanikas_github-repository-analysis)
[](https://sonarcloud.io/summary/new_code?id=balanikas_github-repository-analysis)
## How it works
Given a repository, the system will fetch all publicly available data for that repository,
evaluate it based on a set of rules, and present the results together with additional guidance.
The guidance is generated dynamically using the Open AI GPT-3 model.
https://user-images.githubusercontent.com/2317329/207807236-684bf53d-96c3-4c2c-ac73-c6d5389ab1fa.mov
## How to add a new rule
Lets add a rule that detects whether a readme file exists at the repository root.
#### Create the rule class
Create a rule class in an appropriate category. In this case we choose category `Documentation`
```csharp
public class ReadmeRuleApplicator : IRuleApplicator
{
// annotate questions to be answered by openai gpt-3 model.
[RuleGuidance]
private const string HowToWrite = "Write a short example of a well designed readme file";
[RuleGuidance]
private const string MultipleFiles = "How many readme files can a repository have and why should i have more than one?";
[RuleGuidance(200, Tone.Motivational, Complexity.Simple)]
private const string WhatIs = "What is a github readme file and why is it important?";
public string RuleName => "readme";
public RuleCategory Category => RuleCategory.Documentation;
public Language Language => Language.None; // set to None since the rule is language agnostic
public Task ApplyAsync(AnalysisContext context) =>
throw new NotImplementedException();
}
```
#### Implement the rule
```csharp
public async Task ApplyAsync(AnalysisContext context)
{
// apply the rule using the context object
var node = context.GitTree.FirstFileOrDefault(x => x.PathEquals("readme.md"));
var (diagnosis, note) = GetDiagnosis(node);
(Diagnosis, string) GetDiagnosis(GitTree.Node? n) =>
n is not null
? (Diagnosis.Info, "found")
: (Diagnosis.Error, "missing");
// compose the results
return Rule.Create(this, diagnostics, new Explanation
{
GeneralGuidance = await _gpt3Client.GetCompletions(MultipleFiles, HowToWrite),
Text = await _gpt3Client.GetCompletion(WhatIs),
AboutLink = new Link("about readmes",
"https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes"),
GuidanceLink = diagnostics.Diagnosis == Diagnosis.Error ? context.GetCommunityLink() : null
});
}
```
#### See the rule in the UI
For more info and to get started, see [the contributing document](CONTRIBUTING.md)
## About this service
This service is primarily targeted to small or medium sized repos,
that are owned by a single person or a small group of contributors.
It can be very useful to those getting started with open source projects, but also
for more experienced developers who want to do a quality check of their own repos.
A repository can be configured in many ways, and just because this service produces some warnings
and recommendations based on assumptions and standard practices, doesn't mean that the repository
is in a definitive bad shape.
The analysis is presented as a set of detections, where each detection is either
- `Okay` - looks good and no action needed
- `Can be improved` - an action can be taken for improvement
- `Warning` - strongly recommended to address this
This service currently has extra checks for csharp repositories, but any repository should work for general rules.
For feedback, please create a new issue at https://github.com/balanikas/github-repository-analysis/issues