Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

πŸ“š Update contribution guidelines #1677

Merged

Conversation

samet-akcay
Copy link
Contributor

πŸ“ Description

  • Update CONTRIBUTING.md file
  • Add Developer Guide to the documenation.

Currently developer guide only has the contribution guidelines, but we could add more sections later on.

✨ Changes

Select what type of change your PR is:

  • 🐞 Bug fix (non-breaking change which fixes an issue)
  • πŸ”¨ Refactor (non-breaking change which refactors the code base)
  • πŸš€ New feature (non-breaking change which adds functionality)
  • πŸ’₯ Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • πŸ“š Documentation update
  • πŸ”’ Security update

βœ… Checklist

Before you submit your pull request, please make sure you have completed the following steps:

  • πŸ“‹ I have summarized my changes in the CHANGELOG and followed the guidelines for my type of change (skip for minor changes, documentation updates, and test enhancements).
  • πŸ“š I have made the necessary updates to the documentation (if applicable).
  • πŸ§ͺ I have written tests that support my changes and prove that my fix is effective or my feature works (if applicable).

@samet-akcay samet-akcay requested a review from djdameln January 26, 2024 12:02
@github-actions github-actions bot added the Docs label Jan 26, 2024
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
@samet-akcay samet-akcay requested a review from djdameln January 26, 2024 14:19
@samet-akcay samet-akcay merged commit 5b79045 into openvinotoolkit:main Jan 26, 2024
7 checks passed
@samet-akcay samet-akcay deleted the docs/add-test-instructions branch January 26, 2024 14:20
adrianboguszewski pushed a commit to adrianboguszewski/anomalib that referenced this pull request Feb 9, 2024
* Fix metadata path

* Ignore hidden directories in folder dataset

* Add check for mask_dir for segmentation tasks in Folder dataset

* Limit the gradio version to <4

* create the first version of the developer guide

* Update contributing.md file

* Added octicons to developer guide on docs

* Address PR comments

* Address PR comments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants