Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/algorithm_exploration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: "Algorithm Exploration"
about: "Explore and document findings on a new algorithm or method"
title: "[Algorithm Exploration] "
labels: research
assignees: ''
---

## Algorithm Name
The name of the algorithm or method being explored.

## Source
Link to any paper, repository, or documentation describing the algorithm.

## Objective
What is the purpose of exploring this algorithm? Describe any hypotheses or intended outcomes.

## Setup
- **Tools**: List the software libraries or tools used.
- **Data**: Describe any datasets or inputs used for testing.

## Results and Findings
Summarize the results, including any metrics or observations.

## Potential Applications
List potential areas where this algorithm could be applied within our projects.

## Additional Notes
Include any implementation details, challenges faced, or ideas for future work.
55 changes: 24 additions & 31 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,34 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
name: "Bug Report"
about: "Report a bug or unexpected behavior"
title: "[Bug] "
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.
## Description
A clear and concise description of the bug.

**Screenshots**
If applicable, add screenshots to help explain your problem.
## Steps to Reproduce
1. List the steps to reproduce the bug.
2. Include specific commands, actions, or navigation.
3. Example:
- Open the application
- Click on "Feature X"
- Observe the behavior

**Desktop (please complete the following information):**
## Expected Behavior
What did you expect to happen?

- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
## Actual Behavior
What actually happened? Include any error messages or unexpected behavior observed.

**Smartphone (please complete the following information):**
## Environment
- **OS**: (e.g., Windows, macOS, Linux)
- **Version**: (e.g., application version, library version)
- **Browser**: (if applicable, include browser and version)

- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
## Additional Context
Add any other context about the problem, such as logs, screenshots, or configuration files that might be relevant.

**Additional context**
Add any other context about the problem here.
**Example**: (Optional) Provide a short example of the issue, if applicable.
67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
blank_issues_enabled: false
contact_links:
# Common Templates
- name: "Bug Report"
url: "/intellistream/CANDY/issues/new?template=bug_report.md"
about: "Report a bug or unexpected behavior"

- name: "Feature Request"
url: "/intellistream/CANDY/issues/new?template=feature_request.md"
about: "Suggest a new feature or improvement"

- name: "Documentation Request"
url: "/intellistream/CANDY/issues/new?template=documentation_request.md"
about: "Request improvements or additions to documentation"

- name: "Question"
url: "/intellistream/CANDY/issues/new?template=question.md"
about: "Ask a question about the project"

- name: "Enhancement Request"
url: "/intellistream/CANDY/issues/new?template=enhancement_request.md"
about: "Request an improvement or optimization"

- name: "Performance Issue"
url: "/intellistream/CANDY/issues/new?template=performance_issue.md"
about: "Report a performance issue or inefficiency"

- name: "Security Vulnerability"
url: "/intellistream/CANDY/issues/new?template=security_vulnerability.md"
about: "Report a security vulnerability (confidential)"

- name: "Refactor Request"
url: "/intellistream/CANDY/issues/new?template=refactor_request.md"
about: "Suggest a refactoring to improve code quality"

- name: "Task"
url: "/intellistream/CANDY/issues/new?template=task.md"
about: "Log a general task or maintenance activity"

# Research-Specific Templates
- name: "Paper Discussion"
url: "/intellistream/CANDY/issues/new?template=paper_discussion.md"
about: "Discuss insights, critiques, or questions about a research paper"

- name: "Experiment Tracking"
url: "/intellistream/CANDY/issues/new?template=experiment_tracking.md"
about: "Log the setup, execution, and results of an experiment"

- name: "Dataset Request"
url: "/intellistream/CANDY/issues/new?template=dataset_request.md"
about: "Request a dataset for experiments or analysis"

- name: "Research Collaboration Request"
url: "/intellistream/CANDY/issues/new?template=research_collaboration_request.md"
about: "Request collaboration on a research topic, project, or experiment"

- name: "Research Paper Progress"
url: "/intellistream/CANDY/issues/new?template=research_paper_progress.md"
about: "Log and track the progress of an ongoing research paper"

- name: "Literature Review Request"
url: "/intellistream/CANDY/issues/new?template=literature_review_request.md"
about: "Request a literature review on a specific research topic"

- name: "Algorithm Exploration"
url: "/intellistream/CANDY/issues/new?template=algorithm_exploration.md"
about: "Explore and document findings on a new algorithm or method"
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/dataset_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: "Dataset Request"
about: "Request a dataset for experiments or analysis"
title: "[Dataset Request] "
labels: dataset
assignees: ''
---

## Dataset Name or Type
Specify the name of the dataset or the type of data needed.

## Description
Briefly describe the dataset and why it’s needed.

## Expected Use Cases
List the specific experiments, models, or analyses this dataset will support.

## Requirements
- **Size**: Approximate dataset size.
- **Format**: Preferred data format (e.g., CSV, JSON, image files).
- **Features**: Describe specific features or attributes required.

## Source or Reference (if applicable)
Link to any public dataset or paper that inspired this request.

## Additional Notes
Include any other relevant information or specifics.
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: "Documentation Request"
about: "Request improvements or additions to documentation"
title: "[Docs] "
labels: documentation
assignees: ''
---

## Description
Describe the issue with the documentation or the addition you’re requesting.

## Section of Documentation
Provide the relevant section, page, or file (if applicable).

## Proposed Improvement
Suggest what changes or additions should be made to improve the documentation.

## Additional Context
Add any other context or screenshots to clarify the request.
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: "Enhancement Request"
about: "Request an improvement or optimization"
title: "[Enhancement] "
labels: enhancement
assignees: ''
---

## Summary
Describe the enhancement you’re requesting.

## Why This is Needed
Explain why this improvement would be valuable for the project.

## Suggested Solution
Describe the potential solution or approach for this enhancement.

## Additional Context
Add any other information, screenshots, or context that might be useful.
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/experiment_tracking.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: "Experiment Tracking"
about: "Track the setup, execution, and results of an experiment"
title: "[Experiment] "
labels: experiment
assignees: ''
---

## Experiment Title
A brief title or code name for the experiment.

## Objective
Describe the purpose of this experiment and the hypothesis it aims to test.

## Setup
- **Dataset**: Specify the dataset(s) used.
- **Model/Algorithm**: List the models or algorithms tested.
- **Parameters**: Document key parameters, including hyperparameters and any configurations.

## Execution Steps
Outline the steps taken to run the experiment, including any specific scripts or configurations.

## Results
Summarize the results obtained, such as accuracy, loss, or other relevant metrics.

## Observations
Document any notable patterns, anomalies, or insights observed during the experiment.

## Next Steps
List any follow-up actions based on the results, such as adjusting parameters or trying new datasets.

## Additional Notes
Include any other relevant information or links to related experiments.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: "Feature Request"
about: "Suggest a new feature or improvement"
title: "[Feature] "
labels: enhancement
assignees: ''
---

## Summary
A brief summary of the feature or improvement you’re requesting.

## Problem Statement
Describe the problem or need this feature will address. What limitation does it remove, or what value does it add?

## Proposed Solution
Explain the feature you’re suggesting and how it would work. If you have specific implementation ideas, feel free to include them.

## Alternatives Considered
List any alternative solutions or features you considered and why you believe they aren’t as effective.

## Additional Context
Add any other context or screenshots that might help us understand your request.

**Example**: (Optional) If applicable, provide a short example of what using this feature might look like in practice.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/literature_review_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: "Literature Review Request"
about: "Request a literature review on a specific research topic"
title: "[Literature Review] "
labels: research
assignees: ''
---

## Topic
Briefly describe the research topic or question needing a literature review.

## Key Questions
List specific questions or subtopics to explore in the literature review.

## Scope
- **Time Range**: Specify any publication date range (e.g., past 5 years).
- **Paper Types**: Indicate if only specific types of papers are relevant (e.g., survey papers, experimental studies).

## Expected Outcome
Describe what you’re hoping to achieve with this review (e.g., understanding gaps, comparing methodologies).

## Additional Context
Include any other relevant details, such as related work, previous reviews, or key terms.
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/paper_discussion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: "Paper Discussion"
about: "Discuss insights, critiques, or questions about a research paper"
title: "[Paper Discussion] "
labels: discussion
assignees: ''
---

## Paper Title and Link
Provide the title of the paper and a link to the paper or preprint.

## Summary
A brief summary of the paper, including key findings, methodology, and conclusions.

## Key Insights
List 2-3 key insights from the paper that are relevant to our research.

## Discussion Points
List any questions, critiques, or interesting points that could lead to further discussion or inspire new experiments.

## Relevance to Our Work
Describe how this paper might relate to our ongoing research or potential future directions.

## Additional Context
Include any other comments or context that might help guide the discussion.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/performance_issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: "Performance Issue"
about: "Report a performance issue or inefficiency"
title: "[Performance] "
labels: performance
assignees: ''
---

## Description
Describe the performance issue in detail, including specific areas where it occurs.

## Steps to Reproduce
List the steps or conditions that lead to the performance problem.

## Expected Performance
Describe the expected or ideal performance for the scenario.

## Environment
- **OS**:
- **Hardware Specs** (e.g., CPU, GPU, RAM):
- **Version**: (e.g., application or library version)

## Additional Context
Add any profiling information, logs, screenshots, or context that might help diagnose the issue.
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: "Question"
about: "Ask a question about the project"
title: "[Question] "
labels: question
assignees: ''
---

## Question
Describe your question in detail. Be specific to help us provide a clear answer.

## Additional Context
Provide any relevant code, links, or context that could help clarify the question.
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/refactor_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: "Refactor Request"
about: "Suggest a refactoring to improve code quality"
title: "[Refactor] "
labels: refactor
assignees: ''
---

## Area to Refactor
Specify the code or component that requires refactoring.

## Reason for Refactoring
Explain why this refactor is needed (e.g., to improve readability, reduce complexity).

## Suggested Approach
If possible, describe how the code could be refactored.

## Additional Context
Add any context or links to related code.
Loading
Loading