Skip to content
Closed
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
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/good_first_issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: "Good first issue"
about: "A small, self-contained task suitable for new contributors. Follow the steps and submit a small PR."
title: "Good first issue: [short description]"
labels: ["good first issue", "help wanted"]
assignees: []
body:
- type: markdown
attributes:
value: |
Thank you for helping! This template describes a small task that is suitable for a new contributor.
- type: input
id: description
attributes:
label: "What needs to be done?"
description: "Provide a concise description of the change required and why."
placeholder: "Add examples to README for X; implement unit tests for Y; fix typo in Z."
required: true
- type: input
id: acceptance_criteria
attributes:
label: "Acceptance criteria"
description: "List the checks that will show the task is complete (tests, example run, docs updated)."
placeholder: "1) README has code example; 2) Tests pass on CI"
required: true
- type: textarea
id: steps
attributes:
label: "Suggested steps"
description: "Optional step-by-step guidance for contributors."
placeholder: "1) Fork repo; 2) Create branch; 3) Make changes; 4) Run tests; 5) Open PR."
required: false
- type: dropdown
id: difficulty
attributes:
label: "Difficulty"
options:
- "low"
- "medium"
- "high"
description: "Estimate the difficulty for this task."
required: true
- type: input
id: related_issues
attributes:
label: "Related issues or references"
required: false
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
## How to contribute?

Looking for contributors: This repository and related organizations are seeking contributors for project setup, documentation, CI, tests, and small features. See issue #7546 for the full invitation and list of organizations: https://github.com/TheAlgorithms/Java/issues/7546

NOTE: *We DO NOT add leetcode problems. They are just applications of basic principles that can be found in other algorithms included in the repository.*

### Did you find a bug?
Expand Down
30 changes: 30 additions & 0 deletions CONTRIBUTOR_STARTER.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
Contributor starter template

This small template provides minimal files and guidance that can be used to initialize a new repository or provide a starter PR for an empty project.

Suggested files to add in a starter PR:
- README.md: Short project description, purpose, quick start, and how to contribute.
- CONTRIBUTING.md: Minimal contribution flow (fork -> branch -> PR), coding style notes, testing instructions.
- .github/ISSUE_TEMPLATE/good_first_issue.yml: Template for small tasks for new contributors (already added here).
- LICENSE: e.g., MIT or Apache-2.0.
- .github/workflows/build.yml: Basic CI to run tests on push/PR (optional).

Quick README example:

# ProjectName

Short one-line description.

## Getting started

1. Fork the repository
2. Build with: mvn -q -DskipTests package
3. Run tests: mvn -q test

## Contributing

See CONTRIBUTING.md and look for issues labeled `good first issue`.

---

Use this file as a checklist when opening an initial "starter" PR for a new repo. Keep the PR small and focused on onboarding (docs + ci), not large feature work.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,7 @@ These implementations are intended for learning purposes. As such, they may be l
## Contribution Guidelines
Please read our [Contribution Guidelines](CONTRIBUTING.md) before you contribute to this project.

Looking for contributors? See issue #7546[Contributors Wanted for New Open-Source Projects](https://github.com/TheAlgorithms/Java/issues/7546) for details and ways to get involved.

## Algorithms
Our [directory](DIRECTORY.md) has the full list of applications.
Loading