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.

Sign up for GitHub

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

Jump to bottom

Update docs and other metadata/tooling #16

Merged
24 commits merged into from
Mar 19, 2024
Merged

Update docs and other metadata/tooling #16

24 commits merged into from
Mar 19, 2024

Conversation

AfroThundr3007730
Copy link
Owner

@AfroThundr3007730 AfroThundr3007730 commented Mar 11, 2024 •
edited
Loading

Changed everything but the code basically

  • Added lots of documentation, see README
  • Reorganized files into specific directories
  • Added issue and pull request templates
  • Added configs for CI via CircleCI and Github Actions
  • Fixed a lot of lint and issues resulting from the above
  • Other general cleanup tasks, see commits for details

Pre-Merge TODO:

  • Fill out CHANGELOG before merging this.
  • Investigate whether I need NPM for additional automation
  • Setup Circle CI and get it working with this PR
  • Also setup codecov, codacy, codeclimate, reaction comments
  • Add all the corresponding readme badges, etc.
  • Review my other apps and actions, while we're at it

Review this before merging.

@AfroThundr3007730 AfroThundr3007730 added the docs Documentation related label Mar 11, 2024
@AfroThundr3007730 AfroThundr3007730 self-assigned this Mar 11, 2024
@AfroThundr3007730 AfroThundr3007730 marked this pull request as draft March 11, 2024 18:55
@AfroThundr3007730 AfroThundr3007730 changed the base branch from master to dev March 11, 2024 18:55
@AfroThundr3007730 AfroThundr3007730 changed the title Update docs and other metadata/tooling WIP: Update docs and other metadata/tooling Mar 11, 2024
@github-advanced-security
Copy link

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

@AfroThundr3007730 AfroThundr3007730 linked an issue Mar 11, 2024 that may be closed by this pull request
Do you even CHANGELOG bro? #10
Closed
@AfroThundr3007730 AfroThundr3007730 changed the base branch from dev to master March 11, 2024 19:43
codeclimate[bot]
codeclimate bot reviewed Mar 12, 2024
View reviewed changes
tools/authors.sh Outdated Show resolved Hide resolved
tools/authors.sh Outdated Show resolved Hide resolved
tools/authors.sh Outdated Show resolved Hide resolved
tools/authors.sh Outdated Show resolved Hide resolved
tools/authors.sh Outdated Show resolved Hide resolved
.github/workflows/codacy-analysis.yml Show resolved Hide resolved
.github/workflows/codacy-analysis.yml Show resolved Hide resolved
.github/workflows/codacy-analysis.yml Show resolved Hide resolved
.github/workflows/codacy-analysis.yml Show resolved Hide resolved
.github/workflows/codacy-analysis.yml Show resolved Hide resolved
github-advanced-security[bot]
github-advanced-security bot found potential problems Mar 12, 2024
View reviewed changes
README.md Fixed Show fixed Hide fixed
codeclimate[bot]
codeclimate bot reviewed Mar 12, 2024
View reviewed changes
.github/workflows/codacy-analysis.yml Show resolved Hide resolved
.github/workflows/codacy-analysis.yml Show resolved Hide resolved
.github/workflows/codacy-analysis.yml Show resolved Hide resolved
.github/workflows/codacy-analysis.yml Show resolved Hide resolved
.github/workflows/codacy-analysis.yml Show resolved Hide resolved
.github/workflows/codacy-coverage-reporter.yml Show resolved Hide resolved
.github/workflows/codacy-coverage-reporter.yml Show resolved Hide resolved
.github/workflows/codacy-coverage-reporter.yml Show resolved Hide resolved
.github/workflows/codacy-coverage-reporter.yml Outdated Show resolved Hide resolved
.github/workflows/reaction-comments.yml Show resolved Hide resolved
codeclimate[bot]
codeclimate bot reviewed Mar 12, 2024
View reviewed changes
.github/workflows/codacy-coverage-reporter.yml Show resolved Hide resolved
.github/workflows/codacy-coverage-reporter.yml Show resolved Hide resolved
.github/workflows/codecov-analysis.yml Show resolved Hide resolved
.github/workflows/codecov-analysis.yml Show resolved Hide resolved
.github/workflows/codecov-analysis.yml Outdated Show resolved Hide resolved
.github/workflows/reaction-comments.yml Show resolved Hide resolved
.github/workflows/reaction-comments.yml Show resolved Hide resolved
.github/workflows/reaction-comments.yml Show resolved Hide resolved
.github/workflows/reaction-comments.yml Show resolved Hide resolved
.github/workflows/reaction-comments.yml Show resolved Hide resolved
@codecov Codecov
Copy link

codecov bot commented Mar 12, 2024

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

codeclimate[bot]
codeclimate bot reviewed Mar 12, 2024
View reviewed changes
.github/workflows/reaction-comments.yml Show resolved Hide resolved
.github/workflows/reaction-comments.yml Show resolved Hide resolved
.github/workflows/reaction-comments.yml Outdated Show resolved Hide resolved
.github/workflows/reaction-comments.yml Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
codeclimate[bot]
codeclimate bot reviewed Mar 12, 2024
View reviewed changes
.circleci/config.yml Show resolved Hide resolved
.circleci/config.yml Show resolved Hide resolved
.circleci/config.yml Show resolved Hide resolved
.circleci/config.yml Show resolved Hide resolved
.circleci/config.yml Show resolved Hide resolved
.circleci/config.yml Show resolved Hide resolved
.circleci/config.yml Outdated Show resolved Hide resolved
.circleci/config.yml Show resolved Hide resolved
.circleci/config.yml Show resolved Hide resolved
.circleci/config.yml Show resolved Hide resolved
github-advanced-security[bot]
github-advanced-security bot found potential problems Mar 12, 2024
View reviewed changes
.circleci/config.yml
jobs:
run-shellcheck:
docker:
- image: cimg/base:stable

Check notice

Code scanning / Checkov (reported by Codacy)

Ensure the pipeline image version is referenced via hash not arbitrary tag.

Ensure the pipeline image version is referenced via hash not arbitrary tag.
github-advanced-security[bot]
github-advanced-security bot found potential problems Mar 12, 2024
View reviewed changes
CONTRIBUTING.md Fixed Show fixed Hide fixed
README.md Fixed Show fixed Hide fixed
README.md Fixed Show fixed Hide fixed
README.md Fixed Show fixed Hide fixed
README.md Fixed Show fixed Hide fixed
github-advanced-security[bot]
github-advanced-security bot found potential problems Mar 12, 2024
View reviewed changes
CONTRIBUTING.md Fixed Show fixed Hide fixed
CONTRIBUTING.md Fixed Show fixed Hide fixed
README.md Fixed Show fixed Hide fixed
README.md Fixed Show fixed Hide fixed
README.md Fixed Show fixed Hide fixed
README.md Fixed Show fixed Hide fixed
README.md Fixed Show fixed Hide fixed
README.md Fixed Show fixed Hide fixed
README.md Fixed Show fixed Hide fixed
README.md Fixed Show fixed Hide fixed
@AfroThundr3007730
README.md: Fixed style, added license and contributing
9e610fb 
Signed-off-by: Eddie Carswell <eddiecarswell13@yahoo.com>
@AfroThundr3007730
Added codecov workflow
1c72aa2 
Signed-off-by: Eddie Carswell <eddiecarswell13@yahoo.com>
@AfroThundr3007730
Added .circleci/config.yml
1e53d83 
Signed-off-by: Eddie Carswell <eddiecarswell13@yahoo.com>
@AfroThundr3007730
Convert license to markdown
e921982 
Signed-off-by: Eddie Carswell <eddiecarswell13@yahoo.com>
@AfroThundr3007730
Added SECURITY.md
ccb174f 
Signed-off-by: Eddie Carswell <eddiecarswell13@yahoo.com>
@AfroThundr3007730
Added code of conduct
7b41786 
Signed-off-by: Eddie Carswell <eddiecarswell13@yahoo.com>
@AfroThundr3007730
Updated README with more info and fixed formatting
d59837f 
Signed-off-by: Eddie Carswell <eddiecarswell13@yahoo.com>
@AfroThundr3007730
Added logo (courtesy of icons8)
c60a9fc 
Signed-off-by: Eddie Carswell <eddiecarswell13@yahoo.com>
@AfroThundr3007730
Added github issue templates
7391210 
Signed-off-by: Eddie Carswell <eddiecarswell13@yahoo.com>
@AfroThundr3007730
Added pull request template
5f862e8 
Signed-off-by: Eddie Carswell <eddiecarswell13@yahoo.com>
@AfroThundr3007730
Move everything into specific directories
37c9df9 
- All documentation now in the docs/ directory
- All code now in the src/ directory
- All gitmodules now in the modules/ directory
- LICENSE.md stays in the project root directory

Signed-off-by: Eddie Carswell <eddiecarswell13@yahoo.com>
@AfroThundr3007730
Add logos and ACKNOWLEDGEMENTS.md
716b141 
Signed-off-by: Eddie Carswell <eddiecarswell13@yahoo.com>
@AfroThundr3007730
CHANGELOG.md: Filled out changelog finally, fixed lint
537c37b 
Signed-off-by: Eddie Carswell <eddiecarswell13@yahoo.com>
@AfroThundr3007730
chore: Fix final newlines
90dd311 
Signed-off-by: Eddie Carswell <eddiecarswell13@yahoo.com>
@AfroThundr3007730
README.md: Adjust general layout
0e851ac 
Signed-off-by: Eddie Carswell <eddiecarswell13@yahoo.com>
@AfroThundr3007730
CHANGELOG.md: Adjust style and rework 1.7 notes
d7f993b 
Signed-off-by: Eddie Carswell <eddiecarswell13@yahoo.com>
@AfroThundr3007730
CONTRIBUTING.md: Adjust instructions with more detail
2f9308f 
Signed-off-by: Eddie Carswell <eddiecarswell13@yahoo.com>
@AfroThundr3007730 AfroThundr3007730 marked this pull request as ready for review March 19, 2024 15:43
@AfroThundr3007730 AfroThundr3007730 closed this pull request by merging all changes into master in 2f9308f Mar 19, 2024
AfroThundr3007730
AfroThundr3007730 commented Mar 19, 2024
View reviewed changes
Copy link
Owner Author

@AfroThundr3007730 AfroThundr3007730 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

@AfroThundr3007730 AfroThundr3007730 changed the title WIP: Update docs and other metadata/tooling Update docs and other metadata/tooling Mar 19, 2024
@AfroThundr3007730 AfroThundr3007730 added the epic The long runners, the greats, truly worthy of the title label Mar 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@codeclimate codeclimate[bot] codeclimate[bot] left review comments

Assignees

@AfroThundr3007730 AfroThundr3007730

Labels
docs Documentation related enhancement Enhancing existing capabilities epic The long runners, the greats, truly worthy of the title
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Do you even CHANGELOG bro?
2 participants
@AfroThundr3007730 @fossabot