Skip to content

Latest commit

 

History

History
67 lines (53 loc) · 2.94 KB

CONTRIBUTING.md

File metadata and controls

67 lines (53 loc) · 2.94 KB

Contributing to Jobs API

We're excited that you want to contribute to our project! Your help is highly appreciated and valued. This guide will help you understand how you can contribute, from reporting bugs to submitting pull requests.

Getting Started

Reporting Bugs

If you found a bug, please open an issue in our GitHub repository. Before opening a new issue, check if someone has already reported the same problem. This can save time and effort for everyone.

To report a bug:

  1. Go to the "Issues" tab in our repository.
  2. Click on "New Issue".
  3. Choose the "Bug Report" template.
  4. Fill in all the requested information:
  • A clear and concise description of the problem.
  • Steps to reproduce the bug.
  • Expected behavior.
  • Relevant screenshots or logs.
  • Environment (operating system, project version, etc.).

Suggesting Enhancements

Have an idea to improve the project? Great! Suggestions are always welcome. To ensure your suggestion is clear and easy to understand, follow these steps:

  1. Go to the "Issues" tab in our repository.
  2. Click on "New Issue".
  3. Choose the "Feature Request" template.
  4. Describe your suggestion in detail:
  • What problem does your suggestion solve?
  • How do you think your suggestion should work?
  • Why is this improvement important to you?

Working on Issues

Want to help resolve an existing issue? Follow these steps:

  1. Choose an issue that is not yet assigned to anyone.
  2. Comment on the issue stating that you would like to work on it.
  3. Wait for confirmation from a maintainer before starting.
  4. After confirmation, fork the repository and start working on your own branch.

Submitting Pull Requests

When you are ready to submit your changes, follow these steps to ensure everything is correct:

  1. Ensure your code is well-formatted and follows the project's standards.
  2. Include tests for your changes, if applicable.
  3. Make sure all tests are passing.
  4. Open a pull request:
  • Go to the "Pull Requests" tab in our repository.
  • Click on "New Pull Request".
  • Choose the correct branch to merge into.
  • Describe your changes in detail, including the purpose of the changes and any relevant information.

Pull Request Review

All pull requests will go through a review process. Here are some points we consider during the review:

  • Code clarity: Is your code clean and easy to understand?
  • Correct functionality: Do your changes work as expected?
  • Impact: Do your changes have a positive impact on the project?
  • Documentation: Have you updated the necessary documentation?

Documentation

Please refer to our Documentation for more information on how to use and contribute to the project.

Acknowledgments

We appreciate all our contributors! Every contribution, big or small, helps improve the project.

If you have any questions, feel free to ask in the issues section or directly to the maintainers. We're here to help!

Happy coding!

Developer by: Aleksander Palamar