https://github.com/brenofariasdasilva/worked-example-miner-candidates
This repository complements the Worked-Example-Miner (WEM) project by storing code candidates generated during its execution. These candidates meet the heuristic criteria implemented in WEM and are analyzed by experts. The best candidates, as recommended by experts, can be transformed into Worked Examples to enhance Computer Science lectures.
https://github.com/brenofariasdasilva/worked-example-miner-candidates
code-candidates database experts-analysis wem worked-example-candidates worked-example-miner
Last synced: 4 months ago
JSON representation
This repository complements the Worked-Example-Miner (WEM) project by storing code candidates generated during its execution. These candidates meet the heuristic criteria implemented in WEM and are analyzed by experts. The best candidates, as recommended by experts, can be transformed into Worked Examples to enhance Computer Science lectures.
- Host: GitHub
- URL: https://github.com/brenofariasdasilva/worked-example-miner-candidates
- Owner: BrenoFariasdaSilva
- License: apache-2.0
- Created: 2024-12-17T12:17:56.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-05-29T22:16:50.000Z (6 months ago)
- Last Synced: 2025-05-29T22:36:31.250Z (6 months ago)
- Topics: code-candidates, database, experts-analysis, wem, worked-example-candidates, worked-example-miner
- Language: Python
- Homepage:
- Size: 12.7 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# [Worked-Example-Miner-Candidates.](https://github.com/BrenoFariasdaSilva/Worked-Example-Miner-Candidates) 
---
**Worked-Example-Miner Candidates** is a collaborative project aimed at collecting and organizing candidates for the creation of **Worked Examples** in Computer Science. These candidates are generated by the [Worked-Example-Miner tool](https://github.com/BrenoFariasdaSilva/Worked-Example-Miner) and are categorized based on their relevance for educational purposes.
The repository allows contributions from the community to review, analyze, and classify these candidates to identify the most valuable ones for teaching and learning. Contributors can classify candidates into different stages such as `awaiting review`, `under review`, `approved`, `discarded`, or `needing further review`.
Additionally, **Worked Examples** are created from the **approved candidates** to be used in Computer Science education.
To see the list of current repository candidates, check out the 👉 [**Candidates Table**](#worked-example-candidates).
---
## Table of Contents
- [Worked-Example-Miner-Candidates. ](#worked-example-miner-candidates-)
- [Table of Contents](#table-of-contents)
- [Setup](#setup)
- [Clone the repository](#clone-the-repository)
- [Dataset: Worked-Example Candidates](#dataset-worked-example-candidates)
- [Directory Structure:](#directory-structure)
- [Worked-Example Candidates](#worked-example-candidates)
- [Candidates Summary (Last Updated: 2025-04-30 09:34:37)](#candidates-summary-last-updated-2025-04-30-093437)
- [How to Contribute:](#how-to-contribute)
- [Issue and PR Labeling:](#issue-and-pr-labeling)
- [Contributing](#contributing)
- [How to Cite?](#how-to-cite)
- [Collaborators](#collaborators)
- [License](#license)
- [Apache License 2.0](#apache-license-20)
## Setup
To get started with the project, follow these steps:
### Clone the repository
1. Clone the repository with the following command:
```bash
git clone https://github.com/BrenoFariasDaSilva/Worked-Example-Miner-Candidates.git
cd Worked-Example-Miner-Candidates
```
## Dataset: Worked-Example Candidates
The candidates generated by the [Worked-Example-Miner tool](https://github.com/BrenoFariasdaSilva/Worked-Example-Miner) are located in the **"candidates"** directory of this project. Within this directory, each processed repository has its own folder containing the files related to the candidates for that repository.
We rely heavily on community contributions to analyze these candidates and identify the most relevant ones for creating **Worked Examples** to enhance Computer Science education.
### Directory Structure:
```plaintext
candidates/
│
├── awaiting_review/ # Candidates awaiting initial analysis.
├── under_review/ # Candidates currently being analyzed or discussed.
├── approved_candidates/ # Final candidates approved for Worked Examples.
├── discarded_candidates/ # Candidates determined to be unsuitable.
└── needs_further_review/ # Candidates requiring additional analysis.
worked_examples/ # Concrete Worked Examples created from the approved candidates.
```
## Worked-Example Candidates
This sections contains a markdown table with the current status of the candidates in the repository. The table is updated periodically to reflect the latest changes in the classification of candidates.
### Candidates Summary (Last Updated: 2025-05-29 19:16:49)
| # | Status | Repo Name | Class Candidates | Method Candidates |
|---|--------|----------|------------------|------------------|
| 1 | awaiting_review | advanced-java | 0 | 0 |
| 2 | awaiting_review | allgood-consistent-hash | 0 | 2 |
| 3 | awaiting_review | awesome-system-design-resources | 0 | 0 |
| 4 | awaiting_review | bookkeeper | 258 | 716 |
| 5 | awaiting_review | brooklin | 77 | 219 |
| 6 | awaiting_review | cantor | 0 | 0 |
| 7 | awaiting_review | conductor | 136 | 529 |
| 8 | awaiting_review | copycat | 60 | 135 |
| 9 | awaiting_review | CorfuDB | 333 | 877 |
| 10 | awaiting_review | crail | 18 | 23 |
| 11 | awaiting_review | CronHub | 0 | 0 |
| 12 | awaiting_review | dis-seckill | 0 | 0 |
| 13 | awaiting_review | distkv | 6 | 4 |
| 14 | awaiting_review | distributed-dev-learning | 0 | 0 |
| 15 | awaiting_review | Distributed-System-Algorithms-Implementation | 0 | 0 |
| 16 | awaiting_review | diztl | 11 | 32 |
| 17 | awaiting_review | dslabs | 14 | 5 |
| 18 | awaiting_review | dubbo | 715 | 1687 |
| 19 | awaiting_review | Evon-Executor | 0 | 0 |
| 20 | awaiting_review | file_management_sys | 0 | 0 |
| 21 | awaiting_review | genie | 138 | 353 |
| 22 | awaiting_review | getAheadWithMe | 0 | 0 |
| 23 | awaiting_review | hazelcast | 795 | 2058 |
| 24 | awaiting_review | hp-soa | 8 | 15 |
| 25 | awaiting_review | Hydra | 61 | 228 |
| 26 | awaiting_review | jgroups-raft | 21 | 104 |
| 27 | awaiting_review | jlitespider | 0 | 0 |
| 28 | awaiting_review | JPPF | 462 | 1163 |
| 29 | awaiting_review | Jupiter | 71 | 46 |
| 30 | awaiting_review | kafka | 0 | 0 |
| 31 | awaiting_review | klein | 5 | 8 |
| 32 | awaiting_review | kronotop | 0 | 126 |
| 33 | awaiting_review | Lottor | 0 | 0 |
| 34 | awaiting_review | mangle | 1 | 2 |
| 35 | awaiting_review | memq | 0 | 0 |
| 36 | awaiting_review | MicroRaft | 17 | 144 |
| 37 | awaiting_review | moleculer-java | 54 | 104 |
| 38 | awaiting_review | nosqlbench | 146 | 246 |
| 39 | awaiting_review | pegasus | 97 | 192 |
| 40 | awaiting_review | py4j | 8 | 15 |
| 41 | awaiting_review | rapid | 21 | 50 |
| 42 | awaiting_review | rce | 5 | 5 |
| 43 | awaiting_review | rsf | 42 | 94 |
| 44 | awaiting_review | scalardb | 140 | 646 |
| 45 | awaiting_review | scalecube-cluster | 38 | 109 |
| 46 | awaiting_review | scalecube-services | 99 | 214 |
| 47 | awaiting_review | ScriptSpider | 0 | 0 |
| 48 | awaiting_review | sfs | 0 | 0 |
| 49 | awaiting_review | social-network | 0 | 0 |
| 50 | awaiting_review | southpaw | 6 | 5 |
| 51 | awaiting_review | sparkler | 7 | 2 |
| 52 | awaiting_review | swellrt | 90 | 184 |
| 53 | awaiting_review | swim | 47 | 409 |
| 54 | awaiting_review | tinywheel | 0 | 0 |
| 55 | awaiting_review | trino | 1376 | 3262 |
| 56 | awaiting_review | vertx-in-action | 5 | 2 |
| 57 | awaiting_review | waltz | 30 | 32 |
| 58 | awaiting_review | websocket-cluster | 0 | 0 |
| 59 | awaiting_review | xraft | 24 | 27 |
| 60 | awaiting_review | zookeeper | 52 | 0 |
| **Total** | - | **60 Repositories.** | **5494 Class Candidates.** | **14074 Method Candidates.** |
### How to Contribute:
1. **Analyze the Candidates**: Start by reviewing files in the "awaiting_review" directory.
2. **Move Candidates Based on Your Findings**:
- If you are actively analyzing a candidate, move it to the "under_review" directory.
- If you find a candidate valuable, move it to the "approved_candidates" directory.
- If a candidate is not suitable, move it to the "discarded_candidates" directory.
- If you're uncertain and want further input, move the candidate to the "needs_further_review" directory.
3. **Create a Pull Request (PR)**: Submit your changes with a clear description of your analysis and reasoning.
### Issue and PR Labeling:
When creating an **Issue** or **Pull Request (PR)** related to candidates, please ensure that it is labeled with the corresponding directory name from the following list:
- **awaiting_review**: For candidates that are awaiting initial analysis.
- **under_review**: For candidates currently being analyzed or discussed.
- **approved_candidates**: For candidates that have been thoroughly reviewed and approved for conversion into Worked Examples.
- **discarded_candidates**: For candidates that have been deemed unsuitable and should be excluded from further analysis.
- **needs_further_review**: For candidates that require additional analysis or discussion before making a final decision.
- **worked_examples**: For Issues/PRs related to the creation of Worked Examples from candidates in the **`approved_candidates`** directory.
This helps maintain a clear and organized flow throughout the process.
The organized classification of candidates helps streamline the process of building a high-quality dataset that benefits the broader Computer Science community. Thank you for your support!
## Contributing
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. If you have suggestions for improving the code, your insights will be highly welcome.
In order to contribute to this project, please follow the guidelines below or read the [CONTRIBUTING.md](CONTRIBUTING.md) file for more details on how to contribute to this project, as it contains information about the commit standards and the entire pull request process.
Please follow these guidelines to make your contributions smooth and effective:
1. **Set Up Your Environment**: Ensure you've followed the setup instructions in the [Setup](#setup) section to prepare your development environment.
2. **Make Your Changes**:
- **Create a Branch**: `git checkout -b feature/YourFeatureName`
- **Implement Your Changes**: Make sure to test your changes thoroughly.
- **Commit Your Changes**: Use clear commit messages, for example:
- For new features: `git commit -m "FEAT: Add some AmazingFeature"`
- For bug fixes: `git commit -m "FIX: Resolve Issue #123"`
- For documentation: `git commit -m "DOCS: Update README with new instructions"`
- For refactorings: `git commit -m "REFACTOR: Enhance component for better aspect"`
- For snapshots: `git commit -m "SNAPSHOT: Temporary commit to save the current state for later reference"`
- See more about crafting commit messages in the [CONTRIBUTING.md](CONTRIBUTING.md) file.
3. **Submit Your Contribution**:
- **Push Your Changes**: `git push origin feature/YourFeatureName`
- **Open a Pull Request (PR)**: Navigate to the repository on GitHub and open a PR with a detailed description of your changes.
4. **Stay Engaged**: Respond to any feedback from the project maintainers and make necessary adjustments to your PR.
5. **Celebrate**: Once your PR is merged, celebrate your contribution to the project!
## How to Cite?
If you use the Repository-Name in your research, please cite it using the following BibTeX entry:
```
@misc{WEMCandidates:2024,
title = {This repository complements the Worked-Example-Miner (WEM) project by storing code candidates generated during its execution. These candidates meet the heuristic criteria implemented in WEM and are analyzed by experts. The best candidates, as recommended by experts, can be transformed into Worked Examples to enhance Computer Science lectures.},
author = {Breno Farias da Silva},
year = {2024},
howpublished = {\url{https://github.com/BrenoFariasdaSilva/Worked-Example-Miner-Candidates}},
note = {Accessed on Dezember 17, 2024}
}
```
Additionally, a `main.bib` file is available in the root directory of this repository, in which contains the BibTeX entry for this project.
If you find this repository valuable, please don't forget to give it a ⭐ to show your support! Contributions are highly encouraged, whether by creating issues for feedback or submitting pull requests (PRs) to improve the project. For details on how to contribute, please refer to the [Contributing](#contributing) section below.
Thank you for your support and for recognizing the contribution of this tool to your work!
## Collaborators
We thank the following people who contributed to this project:
## License
### Apache License 2.0
This project is licensed under the [Apache License 2.0](LICENSE). This license permits use, modification, distribution, and sublicense of the code for both private and commercial purposes, provided that the original copyright notice and a disclaimer of warranty are included in all copies or substantial portions of the software. It also requires a clear attribution back to the original author(s) of the repository. For more details, see the [LICENSE](LICENSE) file in this repository.
