Skip to content

jobify

Contributing to Jobify

theseriff/jobify

Contributing to Jobify¶

Thank you for your interest in contributing to Jobify! We are always looking for new contributors.

Getting Started¶

To start contributing, you will need to set up a development environment.

Prerequisites¶

uv: A fast and efficient Python package and project manager.
Just: A handy command-line tool used for various development tasks.

Setup¶

Once you have installed the necessary prerequisites, run the following command to set up your environment:

just init

This command will:

Synchronize the project dependencies using uv.
Install the pre-commit hooks.

Development Workflow¶

Fork the repository and create your own branch from the main branch.
Make your desired changes to the code.
Ensure code quality by running the linter and static analysis tools.
Write and run tests to verify the changes.
Submit a Pull Request for review.

Code Quality¶

We use several tools to ensure high code quality. You can run all of them using the just command:

Linter: Runs Ruff (format and check) and Codespell.
```
just linter
```
Static Analysis: Runs Mypy, Basedpyright, Bandit, Semgrep, and Zizmor.
```
just static-analysis
```
Pre-commit: It's recommended to run pre-commit on all files before pushing.
```
just pre-commit-all
```

Testing¶

Always add tests for new features or bug fixes. We use pytest for testing.

Run all tests:
```
just test-all
```
Run tests with coverage:
```
just test-coverage-all
```

Pull Request Guidelines¶

Make sure your code follows the project's coding style (Ruff).
Keep your pull requests focused. If you have multiple changes that are unrelated, please create separate pull requests.
If you are adding or changing a feature, update the relevant documentation.
All pull requests must pass the continuous integration tests before they can be merged.

Commit Messages¶

We follow the Conventional Commits for our commit messages. This helps in generating changelogs and managing releases automatically.

Format: <type>(<scope>): <description>

Example types:

feat: A new feature
fix: A bug fix
docs: Documentation only changes
style: Changes that do not affect the meaning of the code (white-space, formatting, etc)
refactor: A code change that neither fixes a bug nor adds a feature
perf: A code change that improves performance
test: Adding missing tests or correcting existing tests
chore: Changes to the build process or auxiliary tools and libraries