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

πŸ“š Add sdd and contributing guidelines to the documentation #1708

Merged

Conversation

samet-akcay
Copy link
Contributor

@samet-akcay samet-akcay commented Feb 6, 2024

πŸ“ Description

This PR adds the following to the docs:

  • Add software design document
  • Add contributing guidelines
  • Add code review checklist

✨ 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).

Signed-off-by: Samet Akcay <samet.akcay@intel.com>
Copy link
Collaborator

@ashwinvaidya17 ashwinvaidya17 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I didn't go super deep into it but if required we can merge this

@samet-akcay samet-akcay merged commit 8644440 into openvinotoolkit:main Feb 8, 2024
7 checks passed
@samet-akcay samet-akcay deleted the docs/add-software-design-doc branch February 8, 2024 19:41
adrianboguszewski pushed a commit to adrianboguszewski/anomalib that referenced this pull request Feb 9, 2024
…oolkit#1708)

* Add sdd and contributing guidelines

* Add code-review-checklist

Signed-off-by: Samet Akcay <samet.akcay@intel.com>

---------

Signed-off-by: Samet Akcay <samet.akcay@intel.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants