Skip to content

Latest commit

 

History

History
64 lines (46 loc) · 2.12 KB

CONTRIBUTING.md

File metadata and controls

64 lines (46 loc) · 2.12 KB

Contributing to CastlePass

Thank you for considering contributing to CastlePass! Your support helps make this project better. Whether you're fixing bugs, improving documentation, or suggesting new features, we appreciate every contribution.

How to Contribute

We welcome contributions in the following ways:

  • Fix bugs – Found a bug? Report it or submit a fix!
  • Suggest features – Have an idea? Open an issue and discuss it!
  • Improve documentation – Help make our README, guides, and comments better.
  • Security Enhancements – Help us make this project safer and more secure.

Reporting Issues & Bugs

  • Check existing issues to avoid duplicates.
  • Open a new issue and use our issue template.
  • Provide a clear title and description.
  • Add screenshots or error messages.

Proposing New Features

Before submitting a feature request:

  • Search open/closed issues to check if it’s already suggested.
  • Open a feature request issue and explain:
  • What problem does this solve?
  • How would this improve the project?
  • Any possible challenges?

Set Up & Run CastlePass

  1. Download the prebuilt chrome zip file from here or clone it:

     git clone https://github.com/AtharvaU8/CastlePass.git

  2. Unzip the file.

  3. Open chrome://extensions in Chrome.

  4. Enable developer mode (top right corner).

  5. Click on Load unpacked and select the unzipped folder.

Pull Request Guidelines

  1. Fork the repo and create a new branch

     git checkout -b feature-branch

  2. Make your changes and test locally.

  3. Commit with a meaningful message

     git commit -m "Add feature XYZ"

  4. Push the changes and open a Pull Request (PR)

     git push origin feature-branch

  5. Follow the PR template and explain your changes.

Security & Privacy

CastlePass does not store passwords. If you're contributing security enhancements, follow:

  • Use SHA-256 hashing
  • Maintain Chrome Extension security policies
  • Suggest privacy-focused alternatives

Get in Touch

  • Issues & Bugs: GitHub Issues
  • Feature Requests: Open an issue
  • Discussions: GitHub Discussions or Join the Community

Welcome to CastlePass! We can’t wait to see your contributions!