Chore: Professionalize Repository with Community Standards and DevOps#2
Open
arch-yunus wants to merge 4 commits intoholmescao:mainfrom
Open
Chore: Professionalize Repository with Community Standards and DevOps#2arch-yunus wants to merge 4 commits intoholmescao:mainfrom
arch-yunus wants to merge 4 commits intoholmescao:mainfrom
Conversation
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.
Description
This Pull Request enhances the repository to meet professional open-source standards. It introduces essential community health files, standardizes the development environment with DevOps tools, and improves documentation for better discoverability and citation.
Changes
Added CONTRIBUTING.md: Detailed guidelines for contributors.
Added CODE_OF_CONDUCT.md: Contributor Covenant v1.4 to foster a welcoming environment.
Added SECURITY.md: Policy for reporting vulnerabilities.
Added GitHub Templates:
bug_report.md & feature_request.md for clearer issues.
PULL_REQUEST_TEMPLATE.md to standardize PRs.
Added Makefile: Standardized commands (make install, make lint) for ease of use.
Added CI/CD: GitHub Actions workflow (.github/workflows/ci.yml) to automatically install dependencies and lint code on push.
Added Dependabot: Configuration (.github/dependabot.yml) to keep dependencies up to date.
Added Linting: .flake8 configuration for consistent code style.
Updated .gitignore: Added comprehensive ignore patterns for Python and IDEs.
Enhanced README.md: Added status badges (License, Python, Issues) and a Community section.
Added CITATION.cff: Standard citation file to allow researchers to easily cite "iGrow".
Added CHANGELOG.md: Initialized changelog to track project history.