Conversation
Add community and CI infrastructure: new CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, GitHub issue templates (bug_report, feature_request), a pull request template, and a CI workflow (.github/workflows/ci.yml) that runs pytest across Python 3.9/3.11/3.12. Also update README.md to reference CONTRIBUTING.md and clarify the license link. These changes onboard contributors, provide reporting templates, establish a security contact/process, and enable continuous testing for PRs and pushes to master.
There was a problem hiding this comment.
Pull request overview
Adds contributor-facing documentation and GitHub project scaffolding (templates + CI) to improve onboarding, standardize reporting, and ensure automated test runs on pushes/PRs to master.
Changes:
- Add community health files: CONTRIBUTING, Code of Conduct, Security policy.
- Add GitHub templates for issues and pull requests.
- Add a GitHub Actions CI workflow to run
pytestacross Python 3.9/3.11/3.12 and update README to reference contributing + license.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| SECURITY.md | Introduces a security policy with reporting instructions and scope notes. |
| README.md | Adds a Contributing section and clarifies the license link. |
| CONTRIBUTING.md | Provides development setup, contribution workflow, and (currently) project structure guidance. |
| CODE_OF_CONDUCT.md | Adds Contributor Covenant-based community standards and enforcement section. |
| .github/workflows/ci.yml | Adds CI workflow to run pytest on supported Python versions for pushes/PRs to master. |
| .github/pull_request_template.md | Adds a PR template with testing + documentation checklist. |
| .github/ISSUE_TEMPLATE/feature_request.md | Adds a structured feature request issue template. |
| .github/ISSUE_TEMPLATE/bug_report.md | Adds a structured bug report issue template. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+61
to
+64
| ├── cli.py # CLI entry point (argparse) | ||
| ├── indexer.py # Bookmark parser + embedding | ||
| ├── searcher.py # Vector search logic | ||
| └── store.py # SQLite storage layer |
|
|
||
| ## Questions? | ||
|
|
||
| Open a [discussion](https://github.com/sukanth/mindmark/issues) or reach out via an issue. We're happy to help! |
| cd mindmark | ||
| python3 -m venv .venv | ||
| source .venv/bin/activate # Windows: .venv\Scripts\activate | ||
| pip install -e .[dev] |
Owner
Author
|
@copilot apply changes based on the comments in this thread |
- Quote pip extras and use python -m pip for cross-shell compatibility - Update project structure tree to reflect actual src/mindmark/ layout - Fix misleading 'discussion' link text to match the Issues URL" Agent-Logs-Url: https://github.com/sukanth/mindmark/sessions/444409c7-633a-4e37-92f9-23cb9fc4f44d Co-authored-by: sukanth <8810504+sukanth@users.noreply.github.com>
Agent-Logs-Url: https://github.com/sukanth/mindmark/sessions/444409c7-633a-4e37-92f9-23cb9fc4f44d Co-authored-by: sukanth <8810504+sukanth@users.noreply.github.com>
Contributor
Applied all three review fixes in commit
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add community and CI infrastructure: new CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, GitHub issue templates (bug_report, feature_request), a pull request template, and a CI workflow (.github/workflows/ci.yml) that runs pytest across Python 3.9/3.11/3.12. Also update README.md to reference CONTRIBUTING.md and clarify the license link. These changes onboard contributors, provide reporting templates, establish a security contact/process, and enable continuous testing for PRs and pushes to master.