Skip to content

Commit 6207ebc

Browse files
Reduce pr template size (#85)
* First draft of readme * Contains a simple introduction with installation instructions and misc information * Adding additional information to readme * Added comment about similarity-search * Added a few badges * Updating README.md Changing a section name * Move README to top level. Add acknowledgements section, some additional clean up. * One more small edit. * Trimming down the PR template substantially. --------- Co-authored-by: Aritra Ghosh <aritraghsh09@gmail.com>
1 parent 55cc2cf commit 6207ebc

File tree

1 file changed

+0
-39
lines changed

1 file changed

+0
-39
lines changed

.github/pull_request_template.md

Lines changed: 0 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -22,42 +22,3 @@ If it fixes an open issue, please link to the issue here. If this PR closes an i
2222

2323
## Solution Description
2424
<!-- Please explain the technical solution that I have provided and how it addresses the issue or feature being implemented -->
25-
26-
27-
28-
## Code Quality
29-
- [ ] I have read the Contribution Guide
30-
- [ ] My code follows the code style of this project
31-
- [ ] My code builds (or compiles) cleanly without any errors or warnings
32-
- [ ] My code contains relevant comments and necessary documentation
33-
34-
## Project-Specific Pull Request Checklists
35-
<!--- Please only use the checklist that apply to your change type(s) -->
36-
37-
### Bug Fix Checklist
38-
- [ ] My fix includes a new test that breaks as a result of the bug (if possible)
39-
- [ ] My change includes a breaking change
40-
- [ ] My change includes backwards compatibility and deprecation warnings (if possible)
41-
42-
### New Feature Checklist
43-
- [ ] I have added or updated the docstrings associated with my feature using the [NumPy docstring format](https://numpydoc.readthedocs.io/en/latest/format.html)
44-
- [ ] I have updated the tutorial to highlight my new feature (if appropriate)
45-
- [ ] I have added unit/End-to-End (E2E) test cases to cover my new feature
46-
- [ ] My change includes a breaking change
47-
- [ ] My change includes backwards compatibility and deprecation warnings (if possible)
48-
49-
### Documentation Change Checklist
50-
- [ ] Any updated docstrings use the [NumPy docstring format](https://numpydoc.readthedocs.io/en/latest/format.html)
51-
52-
### Build/CI Change Checklist
53-
- [ ] If required or optional dependencies have changed (including version numbers), I have updated the README to reflect this
54-
- [ ] If this is a new CI setup, I have added the associated badge to the README
55-
56-
<!-- ### Version Change Checklist [For Future Use] -->
57-
58-
### Other Change Checklist
59-
- [ ] Any new or updated docstrings use the [NumPy docstring format](https://numpydoc.readthedocs.io/en/latest/format.html).
60-
- [ ] I have updated the tutorial to highlight my new feature (if appropriate)
61-
- [ ] I have added unit/End-to-End (E2E) test cases to cover any changes
62-
- [ ] My change includes a breaking change
63-
- [ ] My change includes backwards compatibility and deprecation warnings (if possible)

0 commit comments

Comments
 (0)