Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
98 lines (69 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

98 lines (69 loc) · 2.79 KB

Contributing to USCIS Case Tracker

Thank you for considering contributing to the USCIS Case Tracker! This project helps thousands of immigration applicants track their case status privately and securely.

How to Contribute

Reporting Bugs

If you find a bug in the USCIS case tracker:

  1. Check if the issue already exists in GitHub Issues
  2. If not, create a new issue with:
    • Clear description of the bug
    • Steps to reproduce
    • Expected vs actual behavior
    • Browser and OS information
    • Screenshots if applicable

Suggesting Features

We welcome feature suggestions for improving the tracker:

  1. Open a new issue with the "enhancement" label
  2. Describe the feature and its benefits
  3. Explain the use case
  4. Discuss implementation approach if possible

Code Contributions

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/yourusername/uscis-case-tracker.git
  3. Create a branch: git checkout -b feature/your-feature-name
  4. Make your changes
  5. Test thoroughly in multiple browsers
  6. Commit with clear messages
  7. Push to your fork
  8. Create a Pull Request

Development Guidelines

  • Keep it simple: This is a single-file application for simplicity
  • Privacy first: Never add any tracking or external data calls
  • No dependencies: Keep the project dependency-free
  • Responsive design: Test on mobile and desktop
  • Browser compatibility: Support modern browsers (Chrome, Firefox, Safari, Edge)
  • Performance: Keep the page fast and lightweight
  • Accessibility: Follow WCAG guidelines
  • SEO friendly: Maintain semantic HTML and meta tags

Code Style

  • Use clear, descriptive variable names
  • Add comments for complex logic
  • Follow existing code formatting
  • Use modern JavaScript (ES6+)
  • Keep functions small and focused
  • Use CSS custom properties (variables)

Documentation

Help improve documentation:

  • Fix typos and unclear instructions
  • Add examples and use cases
  • Improve the README
  • Add comments to complex code
  • Create tutorials or guides

Spreading the Word

Non-code contributions are valuable too:

  • Star the repository ⭐
  • Share on Reddit immigration forums
  • Write blog posts or tutorials
  • Recommend to friends going through immigration
  • Translate to other languages

Questions?

Feel free to open an issue for any questions about contributing.

Code of Conduct

  • Be respectful and inclusive
  • Help create a welcoming environment
  • Focus on constructive feedback
  • Remember: we're all here to help immigration applicants

License

By contributing, you agree that your contributions will be licensed under the MIT License.

Thank you for helping make immigration case tracking more accessible and private for everyone! 🙏