Build : Add comprehensive project scaffolding and documenntation#307
Merged
Conversation
…files at root, modified & created
…for a better project maintenance
|
🧩 PR Checklist Hi @ayushHardeniya, before merging please ensure:
|
|
|
|
⭐ Hey @ayushHardeniya, if you like this project, don't forget to star the repository! 🚀 |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
📦 Pull Request Overview
📝 What This PR Does
This PR establishes a comprehensive scaffolding for the project.
It adds all necessary documentation, issue/PR templates, CI workflows, and developer configurations to create a robust, contributor-friendly environment.
This update prepares the repository for open-source contributions by providing clear guides, automated templates, and a consistent developer experience.
🔍 Detailed Changes Added
CODE_OF_CONDUCT.md– Based on Contributor Covenant 2.1.2, updated its path & bit content..CONTRIBUTING.md– Comprehensive contribution guidelines, updated path & modified content.CHANGELOG.md– Version history tracker.REPOSITORY_STRUCTURE.md– Complete structure documentation..github/workflows/greetings.yml– GitHub Actions for greetings..vscode/settings.json– VS Code workspace settings..vscode/extensions.json– Recommended extensions for contributors.docs/GETTING_STARTED.md– Beginner-friendly getting started guide.docs/LICENSE_INFO.md– License explanation and usage notes..gitignore– Enhanced ignore patterns for various environments.✅ Result:
A clean, well-documented, and contributor-ready repository structure that promotes consistency and simplifies onboarding for all developers.