This repository has been archived by the owner on Sep 18, 2024. It is now read-only.
Cleanup documentation #113
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ted new issue and pull request file for referencing in contributing guide
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
GuiBibeau
reviewed
May 9, 2024
.gitignore
Outdated
| .DS_Storepackage-lock.json |
There was a problem hiding this comment.
let's add each on a split line and not on the same line
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Comprehensive Cleanup and Documentation Reorganization for Akeru
Description
This pull request implements a series of enhancements aimed at cleaning up and better organizing the documentation and configuration files within the Akeru repository. These changes are designed to improve navigation, enhance readability, and align with best practices for project maintenance.
Key Changes
docsfolder and updated file extensions to lowercase to maintain consistency across the project.package-lock.jsonand updated.gitignoreto prevent it from being tracked, aligning with our use of Bun as our package manager.Detailed Changes
CODE_OF_CONDUCT.md,CODING_CONVENTIONS.md,CONTRIBUTING.md, andDOCUMENTATION_STYLE_GUIDE.mdto thedocsdirectory.CODING_CONVENTIONS.MDtocoding_conventions.mdto standardize naming conventions.ISSUES_TEMPLATE.mdto.github/ISSUE_TEMPLATEandPULL_REQUEST_DOC_TEMPLATE.mdto.github/PULL_REQUEST_DOC_TEMPLATE, assessing its usage versus the existingPULL_REQUEST_TEMPLATE.md.package-lock.jsonto.gitignoreand removed existing file from the repository.Motivation and Context
These updates address feedback from the community and internal discussions about maintaining a clean and navigable repository. By organizing our documentation and templates more intuitively and removing unused files, we enhance every contributor's ability to interact with and contribute to the project efficiently.
Link to Issue
Request for Review
Looking forward to your feedback and suggestions on these updates. Your insights are invaluable to ensure that our repository remains well-organized and our documentation is clear and accessible.