Skip to content

PRE_COMMIT_CHECKLIST.md

Latest commit

 

History

History
134 lines (94 loc) · 4.43 KB

PRE_COMMIT_CHECKLIST.md

File metadata and controls

134 lines (94 loc) · 4.43 KB

Pre-Commit Checklist for GitHub Publication

This checklist will help you prepare your repository for public release on GitHub.

✅ Completed

The following items have been set up for you:

  • README.md - Comprehensive documentation with installation, usage, and contribution guidelines
  • LICENSE - MIT License file added
  • CONTRIBUTING.md - Contribution guidelines for potential contributors
  • SECURITY.md - Security policy and vulnerability reporting process
  • CHANGELOG.md - Version history and release notes
  • .gitignore - Comprehensive ignore file for Salesforce projects
  • .npmrc - Prevents accidental npm publishing
  • GitHub Issue Templates - Bug report and feature request templates
  • Pull Request Template - Standardized PR template
  • Git Repository - Initialized with 'main' branch
  • Package.json - Updated with proper metadata and marked as private
  • VS Code Configuration - Extensions and settings included for contributors

📝 Action Items Before Publishing

Before pushing to GitHub, please complete these steps:

1. Review and Update Personal Information

  • README.md: Replace yourusername in the repository URL with your actual GitHub username
  • package.json:
    • Update the repository.url field with your actual GitHub username
    • Add your name/email to the author field if desired
  • LICENSE: Add your name to the copyright line if desired

2. Verify No Sensitive Information

  • Review all files to ensure no API keys, passwords, or sensitive data
  • Check that no personal email addresses or internal URLs are exposed
  • Verify all Salesforce org credentials are excluded

3. Review Code Quality

Run these commands to ensure code quality:

# Install dependencies
npm install

# Run linter
npm run lint

# Format code
npm run prettier

# Run tests (if you have tests written)
npm run test:unit

4. Create Initial Commit

# Review staged files
git status

# Commit all files
git commit -m "Initial commit: LWC Sub-Page Navigation v1.0.0"

5. Create GitHub Repository

  1. Go to https://github.com/new
  2. Create a new repository named lwcSubPageNavigation
  3. DO NOT initialize with README, license, or .gitignore (we already have these)
  4. Set repository visibility to Public

6. Push to GitHub

# Add your GitHub repository as remote (replace with your actual URL)
git remote add origin https://github.com/yourusername/lwcSubPageNavigation.git

# Push to GitHub
git push -u origin main

7. Configure GitHub Repository Settings

Once pushed, configure these settings on GitHub:

  • About section: Add description and topics (salesforce, lwc, experience-cloud, etc.)
  • Issues: Enable issues for bug reports and feature requests
  • Projects: Consider creating a project board for tracking enhancements
  • Wiki: Optional - enable if you want extended documentation
  • Branch Protection: Consider protecting the main branch
    • Require pull request reviews before merging
    • Require status checks to pass before merging

8. Optional: Add Badges to README

Consider adding these badges to your README.md:

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Salesforce API](https://img.shields.io/badge/Salesforce%20API-v65.0-blue.svg)](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/)

9. Create First Release

After pushing:

  1. Go to your repository's "Releases" page
  2. Click "Create a new release"
  3. Tag: v1.0.0
  4. Title: v1.0.0 - Initial Release
  5. Copy content from CHANGELOG.md
  6. Publish release

10. Share Your Project

  • Share on LinkedIn, Twitter, or relevant Salesforce communities
  • Consider posting in Salesforce Trailblazer Community
  • Add to awesome-salesforce lists if applicable

📚 Additional Resources

🎉 You're Ready!

Once you've completed all the action items above, your repository will be ready for public contribution!

Good luck with your open source project! 🚀