Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add README #76

Merged
merged 1 commit into from
Sep 29, 2024
Merged

docs: Add README #76

merged 1 commit into from
Sep 29, 2024

Conversation

JackPlowman
Copy link
Owner

@JackPlowman JackPlowman commented Sep 29, 2024

Pull Request

Description

This pull request introduces several changes to improve the project structure and documentation:

  1. Added a new README.md file with comprehensive project information:
    • Included a table of contents
    • Added an introduction section explaining the project's purpose
    • Provided usage instructions for the GitHub Action
    • Detailed GitHub Action inputs and their descriptions

These changes enhance the project's readability and provide clear guidance for users implementing the GitHub Stats Analyser as a GitHub Action.

fixes #74

Copy link
Owner Author

JackPlowman commented Sep 29, 2024

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @JackPlowman and the rest of your teammates on Graphite Graphite

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Sep 29, 2024
@JackPlowman JackPlowman changed the title Add Readme docs: Add README Sep 29, 2024
@JackPlowman JackPlowman marked this pull request as ready for review September 29, 2024 20:48
@JackPlowman JackPlowman changed the base branch from 09-29-add_conventional_commits_documentation to graphite-base/76 September 29, 2024 20:49
@JackPlowman JackPlowman changed the base branch from graphite-base/76 to main September 29, 2024 20:50
@JackPlowman JackPlowman force-pushed the 09-29-add_readme branch 2 times, most recently from 60edc3d to d64b9a4 Compare September 29, 2024 20:54
Copy link

sonarcloud bot commented Sep 29, 2024

@JackPlowman JackPlowman merged commit 03a5f2c into main Sep 29, 2024
29 checks passed
Copy link
Owner Author

Merge activity

@JackPlowman JackPlowman deleted the 09-29-add_readme branch September 29, 2024 21:01
JackPlowman added a commit that referenced this pull request Sep 29, 2024
🤖 I have created a release *beep* *boop*
---


## 1.0.0 (2024-09-29)


### 🚀 Features

* Migrate Analyser to Repository
([#27](#27))
([9beaa22](9beaa22)),
closes
[#10](#10)


### 📝 Documentation

* Add Conventional Commits specification
([#75](#75))
([aa869fc](aa869fc)),
closes
[#73](#73)
* Add README
([#76](#76))
([03a5f2c](03a5f2c)),
closes
[#74](#74)


### 🧰 Maintenance

* Add .gitattributes for JSON and YAML detection
([#45](#45))
([1d93833](1d93833)),
closes
[#41](#41)
* Add .prettierignore file to exclude CHANGELOG.md
([#46](#46))
([203a868](203a868)),
closes
[#42](#42)
* Add code quality workflow and linter configurations
([#25](#25))
([cfa2a81](cfa2a81)),
closes
[#9](#9)
* Add code test workflow
([#38](#38))
([3810fc0](3810fc0)),
closes
[#34](#34)
* Add CodeQL Analysis workflow
([#36](#36))
([acc59f1](acc59f1)),
closes
[#33](#33)
* Add Dependabot Version Updates
([#31](#31))
([38ec825](38ec825)),
closes
[#32](#32)
* Add Dependency Review workflow
([#37](#37))
([6f20397](6f20397)),
closes
[#34](#34)
* Add Docker build and test job to code-test workflow
([#66](#66))
([12f736c](12f736c)),
closes
[#64](#64)
* Add Docker dependency updates and optimise Dockerfile
([#67](#67))
([20586b8](20586b8)),
closes
[#65](#65)
* Add Dockerfile and Docker build command
([#63](#63))
([0a189be](0a189be)),
closes
[#59](#59)
* Add EditorConfig
([#20](#20))
([aa1ea11](aa1ea11)),
closes
[#2](#2)
* Add Git hooks for pre-commit and post-commit checks
([#56](#56))
([d37c424](d37c424)),
closes
[#47](#47)
* Add GitHub Action
([#68](#68))
([b203441](b203441)),
closes
[#58](#58)
* Add GitHub issue templates and config
([#55](#55))
([f86ef79](f86ef79)),
closes
[#51](#51)
* Add Justfile format check to code quality workflow
([#43](#43))
([9fe1308](9fe1308)),
closes
[#39](#39)
* Add label sync workflow and configuration
([#23](#23))
([3f12d38](3f12d38)),
closes
[#7](#7)
* Add Markdown link checker to code quality workflow
([#44](#44))
([7da3500](7da3500)),
closes
[#40](#40)
* Add Output Schema Validation
([#53](#53))
([1e2599e](1e2599e)),
closes
[#49](#49)
* Add PR labeler workflow and configuration
([#24](#24))
([c03cbbc](c03cbbc)),
closes
[#8](#8)
* Add Pull Request Template
([#19](#19))
([03b0fb9](03b0fb9)),
closes
[#1](#1)
* Add Pull Request Title Check
([#21](#21))
([c44783d](c44783d)),
closes
[#5](#5)
* Add Python code quality checks to workflow
([#30](#30))
([0ebd090](0ebd090)),
closes
[#29](#29)
* Add schema validation job to code-test workflow
([#54](#54))
([dd688f4](dd688f4)),
closes
[#52](#52)
* Add SonarCloud scan to code-test workflow
([#62](#62))
([eebec1a](eebec1a)),
closes
[#48](#48)
* Add Visual Studio Code debug and settings configurations
([#57](#57))
([9e81f1f](9e81f1f)),
closes
[#50](#50)
* Fix CHANGELOG.md warnings
([#79](#79))
([44ed05f](44ed05f)),
closes
[#80](#80)
* Fix SonarCloud coverage path and update test commands
([#70](#70))
([2710fbe](2710fbe)),
closes
[#69](#69)
* init
([fc17219](fc17219))
* Remove version from pyproject.toml
([#77](#77))
([1d48360](1d48360)),
closes
[#78](#78)
* Rename project to github-stats-analyser
([#61](#61))
([cb3760f](cb3760f)),
closes
[#60](#60)
* Run Release Please
([#22](#22))
([829b477](829b477)),
closes
[#6](#6)
* Update Justfile with new tasks and refactor existing ones
([#28](#28))
([dac1591](dac1591)),
closes
[#11](#11)
* Update Visual Studio Code settings
([#72](#72))
([ceb7f31](ceb7f31)),
closes
[#71](#71)

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Readme documentation
1 participant