|
| 1 | +### Contributing to CastlePass Web |
| 2 | +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. |
| 3 | + |
| 4 | +### How to Contribute |
| 5 | +We welcome contributions in the following ways: |
| 6 | + |
| 7 | +- Fix bugs – Found a bug? Report it or submit a fix! |
| 8 | +- Suggest features – Have an idea? Open an issue and discuss it! |
| 9 | +- Improve documentation – Help make our README, guides, and comments better. |
| 10 | +- Security Enhancements – Help us make this project safer and more secure. |
| 11 | + |
| 12 | +### Reporting Issues & Bugs |
| 13 | + |
| 14 | +- Check existing issues to avoid duplicates. |
| 15 | +- Open a new issue and use our issue template. |
| 16 | +- Provide a clear title and description. |
| 17 | +- Add screenshots or error messages. |
| 18 | + |
| 19 | +### Proposing New Features |
| 20 | +Before submitting a feature request: |
| 21 | + |
| 22 | +- Search open/closed issues to check if it’s already suggested. |
| 23 | +- Open a feature request issue and explain: |
| 24 | +- What problem does this solve? |
| 25 | +- How would this improve the project? |
| 26 | +- Any possible challenges? |
| 27 | + |
| 28 | +### Set Up & Run CastlePass |
| 29 | + |
| 30 | +1. Download the prebuilt chrome zip file from here or clone it: |
| 31 | + |
| 32 | + git clone https://github.com/AtharvaU8/CastlePass.git |
| 33 | +2. Unzip the file. |
| 34 | +3. Open chrome://extensions in Chrome. |
| 35 | +4. Enable developer mode (top right corner). |
| 36 | +5. Click on Load unpacked and select the unzipped folder. |
| 37 | + |
| 38 | +### Pull Request Guidelines |
| 39 | +1. Fork the repo and create a new branch |
| 40 | + |
| 41 | + git checkout -b feature-branch |
| 42 | +2. Make your changes and test locally. |
| 43 | +3. Commit with a meaningful message |
| 44 | + |
| 45 | + git commit -m "Add feature XYZ" |
| 46 | +4. Push the changes and open a Pull Request (PR) |
| 47 | + |
| 48 | + git push origin feature-branch |
| 49 | +5. Follow the PR template and explain your changes. |
| 50 | + |
| 51 | +### Security & Privacy |
| 52 | +CastlePass does not store passwords. If you're contributing security enhancements, follow: |
| 53 | + |
| 54 | +- Use SHA-256 hashing |
| 55 | +- Maintain Chrome Extension security policies |
| 56 | +- Suggest privacy-focused alternatives |
| 57 | + |
| 58 | +### Get in Touch |
| 59 | + |
| 60 | +- Issues & Bugs: GitHub Issues |
| 61 | +- Feature Requests: Open an issue |
| 62 | +- Discussions: GitHub Discussions or Join the Community |
| 63 | + |
| 64 | +Welcome to CastlePass! We can’t wait to see your contributions! |
0 commit comments