Skip to content

Commit cd99c0f

Browse files
authored
Merge branch 'master' into master
2 parents 58168e8 + 9d86348 commit cd99c0f

File tree

162 files changed

+5249
-1561
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

162 files changed

+5249
-1561
lines changed

.github/CODEOWNERS

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
* @siriak @yanglbme
1+
* @siriak @yanglbme @debasishbsws

.github/ISSUE_TEMPLATE/bug_report.md

-29
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.yml

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: "Bug report"
2+
description: "Create a report to help us improve"
3+
title: "[BUG] <title>"
4+
labels: ["bug"]
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: "Description"
10+
description: "A clear and concise description of what the bug is."
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: steps
15+
attributes:
16+
label: "Steps to reproduce"
17+
description: "Steps to reproduce the behavior (if applicable)"
18+
placeholder: |
19+
1. Go to '...'
20+
2. Click on '....'
21+
3. Scroll down to '....'
22+
4. See error
23+
validations:
24+
required: false
25+
- type: textarea
26+
id: exceptedbhv
27+
attributes:
28+
label: "Excepted behavior"
29+
description: "A clear and concise description of what you expected to happen."
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: screenshots
34+
attributes:
35+
label: "Screenshots"
36+
description: "If applicable, add screenshots to help explain your problem."
37+
validations:
38+
required: false
39+
- type: textarea
40+
id: context
41+
attributes:
42+
label: "Additional context"
43+
description: "Is there anything else we should know about this bug report?"
44+
validations:
45+
required: false

.github/ISSUE_TEMPLATE/config.yml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Discord community
4+
url: https://the-algorithms.com/discord/
5+
about: Have any questions or found any bugs? Please contact us via Discord

.github/ISSUE_TEMPLATE/feature_request.md

-19
This file was deleted.
+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: "Feature Request"
2+
description: "Suggest an idea for this project"
3+
title: "[FEATURE REQUEST] <title>"
4+
labels: ["enhancement"]
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: What would you like to Propose?
10+
description: Provide a clear and concise explanation of your Proposal.
11+
validations:
12+
required: true
13+
- type: markdown
14+
attributes:
15+
value: |
16+
For new implementations, please specify the name and problem statement for the algorithm.
17+
For algorithm enhancements, specify what needs to be changed and why. For example:
18+
- Adding tests.
19+
- Optimizing logic.
20+
- Refactoring the file and folders for better structure.
21+
- type: textarea
22+
id: needdetails
23+
attributes:
24+
label: "Issue details"
25+
description: "Write down all the issue/algorithm details description mentioned above."
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: extrainfo
30+
attributes:
31+
label: "Additional Information"
32+
description: "Add any other information or screenshots about the request here."
33+
validations:
34+
required: false

.github/ISSUE_TEMPLATE/other.yml

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Other
2+
description: Use this for any other issues. Do NOT create blank issues
3+
title: "[OTHER]"
4+
labels: ["awaiting triage"]
5+
body:
6+
- type: textarea
7+
id: issuedescription
8+
attributes:
9+
label: What would you like to share?
10+
description: Provide a clear and concise explanation of your issue.
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: extrainfo
15+
attributes:
16+
label: Additional information
17+
description: Is there anything else we should know about this issue?
18+
validations:
19+
required: false

.github/pull_request_template.md

+4-20
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,7 @@
1-
### **Describe your change:**
2-
3-
- [ ] Add an algorithm?
4-
- [ ] Fix a bug or typo in an existing algorithm?
5-
- [ ] Documentation change?
6-
7-
#### References
8-
9-
<!-- Add any reference to previous pull-request or issue -->
10-
11-
### **Checklist:**
12-
13-
<!-- Remove items that do not apply. For completed items, change [ ] to [x]. -->
1+
<!-- For completed items, change [ ] to [x] -->
142

153
- [ ] I have read [CONTRIBUTING.md](https://github.com/TheAlgorithms/Java/blob/master/CONTRIBUTING.md).
16-
- [ ] This pull request is all my own work -- I have not plagiarized.
17-
- [ ] I know that pull requests will not be merged if they fail the automated tests.
18-
- [ ] This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
19-
- [ ] All new Java files are placed inside an existing directory.
20-
- [ ] All filenames are in all uppercase characters with no spaces or dashes.
4+
- [ ] This pull request is all my own work -- I have not plagiarized it.
5+
- [ ] All filenames are in PascalCase.
216
- [ ] All functions and variable names follow Java naming conventions.
22-
- [ ] All new algorithms have a URL in its comments that points to Wikipedia or other similar explanation.
23-
- [ ] If this pull request resolves one or more open issues then the commit message contains `Fixes: #{$ISSUE_NO}`.
7+
- [ ] All new algorithms have a URL in their comments that points to Wikipedia or other similar explanations.

.github/workflows/build.yml

+1-13
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,5 @@
11
name: Build
2-
on:
3-
push:
4-
paths:
5-
- 'src/**'
6-
- '**.yml'
7-
- '**.xml'
8-
- '**.Dockerfile'
9-
pull_request:
10-
paths:
11-
- 'src/**'
12-
- '**.yml'
13-
- '**.xml'
14-
- '**.Dockerfile'
2+
on: [push, pull_request]
153
jobs:
164
build:
175
runs-on: ubuntu-latest

CONTRIBUTING.md

+14-12
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,28 @@
11
## How to contribute?
22

3-
#### **Did you find a bug?**
3+
### Did you find a bug?
44

5-
- **Ensure the bug was not already reported** by searching on GitHub under [Project Issues](https://github.com/TheAlgorithms/Java/issues).
5+
**Ensure the bug was not already reported** by searching on GitHub under [Project Issues](https://github.com/TheAlgorithms/Java/issues).
6+
- If it is mentioned in the issues and you want to fix it, [fork](https://github.com/TheAlgorithms/Java/fork) the repository and submit your implementation in a pull request. The project maintainers will evaluate it.
7+
- If the bug is **NOT** mentioned in the issues, [open a new issue](https://github.com/TheAlgorithms/Java/issues/new). Be sure to include a **title**, a clear **description** and a **test case** demonstrating the expected behavior that is not occurring.
68

7-
- Please avoid opening issues asking to be "assigned to a particular algorithm. This merely creates unnecessary noise for maintainers. Instead, please submit your implementation in a pull request and project maintainers will evaluate it.
9+
NOTE: *Please avoid opening issues asking to be "assigned" to a particular algorithm. This merely creates unnecessary noise for maintainers. Instead, please submit your implementation in a pull request and project maintainers will evaluate it.*
810

9-
- If you are unable to find an open issue referring to the same problem, depending on the type of issue follow the appropriate steps:
1011

11-
#### **Do you want to contribute to the documentation?**
1212

13-
- Please read the documentation here [Contributing to the Documentation](https://github.com/TheAlgorithms/Java/blob/master/CONTRIBUTING.md), [open a new issue](https://github.com/TheAlgorithms/Java/issues/new), make changes, and then create a pull request, it will be put under review and accepted if it is appropriate.
13+
### Do you want to contribute to the documentation?
14+
- [Fork](https://github.com/TheAlgorithms/Java/fork) the repository and make necessary changes.
15+
- Create a pull request.
16+
- It will be put under review for approval.
17+
- If approved, the requested changes will be merged to the repository.
1418

15-
#### **Do you want to add a new feature?**
19+
### Do you want to add a new feature?
1620

17-
- [Open a new issue](https://github.com/TheAlgorithms/Java/issues/new). Be sure to include a **title, clear description** and **test case** demonstrating the new feature you want to add to the project.
21+
- [Open a new issue](https://github.com/TheAlgorithms/Java/issues/new).
22+
- Be sure to include a **title**, a clear **description** and a **test case** demonstrating the new feature you want to add to the project.
1823

19-
#### **Do you want to fix a bug?**
2024

21-
- [Open a new issue](https://github.com/TheAlgorithms/Java/issues/new). Be sure to include a **title and a clear description** and a **test case** demonstrating the expected behavior that is not occurring.
22-
23-
#### **Do you have questions about the source code?**
25+
### Do you have questions about the source code?
2426

2527
- Ask any question about how to use the repository in the [TheAlgorithms room in GITTER](https://gitter.im/TheAlgorithms/community?source=orgpage#) or [open a new issue](https://github.com/TheAlgorithms/Java/issues/new)
2628

0 commit comments

Comments
 (0)