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

chore: implement repository standards and templates #26

Merged
merged 3 commits into from
Jan 26, 2025

Conversation

jmartinn
Copy link
Collaborator

@jmartinn jmartinn commented Jan 21, 2025

Description

This PR implements repository standards and community guidelines to establish consistent development practices and improve contributor experience. It adds essential documentation, sets up proper Git configurations, and introduces standardized templates for issues and pull requests.

Closes #21

Changes Made

  • Added comprehensive community guidelines in CODE_OF_CONDUCT.md
  • Created detailed contribution instructions in CONTRIBUTING.md
  • Enhanced NOTICE file with proper Apache 2.0 attribution requirements
  • Updated LICENSE file to use official Apache 2.0 formatting
  • Implemented standardized templates in .github/ directory:
    • Issue templates for bug reports, feature requests, and general issues
    • Pull request template with comprehensive checklist
  • Added global .gitignore file with common patterns
  • Removed system-generated .DS_Store files

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Code refactoring
  • Performance improvement

Testing

  • Manual testing performed
  • Unit tests added/updated
  • Integration tests added/updated

Test Instructions

  1. Checkout branch
  2. Verify all new documentation files are present and properly formatted
  3. Create a test issue using new templates
  4. Create a test PR using new template
  5. Verify .gitignore is working by creating a .DS_Store file (it should be ignored)

Additional Notes

This PR focuses on standardizing repository structure and documentation. The changes are foundational for maintaining a consistent development environment and improving the contribution workflow.

Sets up repository standards and documentation following open source best
practices:

- Adds standard GitHub templates for issues and pull requests in .github/
- Creates community guidelines with CODE_OF_CONDUCT.md and CONTRIBUTING.md
- Updates LICENSE file to use official Apache 2.0 format
- Expands NOTICE file with proper attribution
- Implements global .gitignore file
- Removes .DS_Store system files

This standardization effort aims to improve collaboration and maintainability
while ensuring proper licensing and attribution.

Closes StrapexLabs#22
@jmartinn jmartinn force-pushed the chore/setup-repo-standards branch from 6c8c031 to 72eeaa6 Compare January 21, 2025 01:27
@machuwey machuwey self-requested a review January 21, 2025 18:16
jmartinn added a commit to jmartinn/strapex that referenced this pull request Jan 24, 2025
Based on architectural review feedback, the landing page will be maintained
in a separate repository to ensure better separation of concerns.

Related to PR StrapexLabs#26
@machuwey machuwey merged commit 4dddfe5 into StrapexLabs:main Jan 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

chore: implement repository standards and templates
2 participants