search

redhat-beyond / JobSeeker

https://github.com/redhat-beyond/JobSeeker
MIT License
2 stars 5 forks source link

📝 Adding A `CONTRIBUTING.md` File #16

Closed taljacob2 closed 2 years ago

taljacob2 commented 2 years ago

A CONTRIBUTING.md file, in an open source repository or site, provides potential project contributors with a short guide to how they can help with the project.

CONTRIBUTING.md is a file that contains all the guidelines for contributing to JobSeeker and its packages.

Table Of Contents

You can view this file on my branch here.

Signed-off-by: Tal Jacob taljacob2@gmail.com

taljacob2 commented 2 years ago

I would recommend adding:

  • Contact through slack, with link

    os-07-group4 on beyond slack

  • Verify PR is ready for Core Review. Please elaborate what actions needed

I have updated the file in 68ce24a. You may review.

Yarboa commented 2 years ago

I would recommend adding:

  • Contact through slack, with link

    os-07-group4 on beyond slack

  • Verify PR is ready for Core Review.

This one should be discussed by all of you, In one of the following: the PR itself, Issue related to PR or slack channel

Please elaborate what actions needed

I have updated the file in 68ce24a. You may review.

@paOmer @ShirleyFichman @DeanBiton @amittcohen see inline above

taljacob2 commented 2 years ago

Most important thing is not here:

What are the steps PR is ready for CR review?

  1. git hub actions PASSED ok
  2. PRs should be small as much as possible
  3. New features/Fixes must include tests
  4. PR must be well explained (add link to the guideline in this page)
  5. PR must be bound with Issue (add link to guideline in this page)
  6. At least 2 contributes

I have added your notes in this commit: 8a341d2. You may review.