Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (28 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

44 lines (28 loc) · 1.61 KB

Contributing to JobTrackerPro

Hi there! 👋

Thanks for checking out JobTrackerPro. I developed this project solo to showcase my skills and build a useful tool for job seekers.

While I am the primary maintainer, I am huge fan of open source and would love to see other developers get involved. Whether you want to fix a bug I missed, refactor some legacy logic, or suggest a cool new feature, I'm open to it.

💡 How You Can Help

Since it's just me maintaining this right now, here is what would be most helpful:

  • Bug Reports: If you break something, let me know! Open an issue with details.
  • Feature Ideas: I have a roadmap, but if you think of something better (like a new integration), open a discussion.
  • Code Review: If you see a way to optimize my queries or improve my stream processing, feel free to open a PR.

📝 My Coding Standards

To keep the codebase clean and manageable for me, I ask that you stick to these guidelines:

  1. Java 21 Features: I use modern Java. Please use records, pattern matching, and var where appropriate.
  2. Controller/Service Split: Keep the controllers dumb. Put the logic in the services.
  3. Conventional Commits: I use semantic commit messages to keep my history readable.
    • feat: ... for new stuff
    • fix: ... for bugs
    • refactor: ... for code cleanup

📬 Submitting a Pull Request

  1. Fork the repo.
  2. Create your branch (git checkout -b my-new-feature).
  3. Commit your changes.
  4. Push to your branch.
  5. Open a PR against my dev branch.

I'll do my best to review it as soon as I can!

Happy Coding! 💻