Skip to content

Commit 20e7dfa

Browse files
authored
Update docs (#219)
* Add stale bot * Update pull request template * Update contributing section in README.md
1 parent e45853a commit 20e7dfa

3 files changed

Lines changed: 73 additions & 8 deletions

File tree

.github/pull_request_template.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
1-
Please include a summary of the change. Please also include relevant motivation and context (if applicable).
1+
Please include a summary of the change.
2+
Please also include relevant motivation and context (if applicable).
3+
Put 'x' in between square brackets to mark an item as complete.
24

35
- [ ] I have performed a self-review of my code
46
- [ ] My code follows the style guidelines of this project
5-
- [ ] I have added comments to hard-to-understand areas of my code
67
- [ ] I have added tests that prove my fix is effective or that my feature works
78
- [ ] New and existing unit tests pass locally with my changes
8-
- [ ] I have made corresponding changes to the comments
9+
- [ ] Comments in areas I changed are up to date
10+
- [ ] I have added comments to hard-to-understand areas of my code
911
- [ ] I have made corresponding changes to the README.md
12+
- [ ] I have made corresponding changes to the DIRECTORY.md

.github/stale.yml

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Configuration for probot-stale - https://github.com/probot/stale
2+
3+
# Number of days of inactivity before an Issue or Pull Request becomes stale
4+
daysUntilStale: 30
5+
6+
# Number of days of inactivity before an Issue or Pull Request with the stale label is closed.
7+
# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale.
8+
daysUntilClose: 7
9+
10+
# Only issues or pull requests with all of these labels are check if stale. Defaults to `[]` (disabled)
11+
onlyLabels: []
12+
13+
# Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable
14+
exemptLabels:
15+
- "dont-close"
16+
17+
# Set to true to ignore issues in a project (defaults to false)
18+
exemptProjects: false
19+
20+
# Set to true to ignore issues in a milestone (defaults to false)
21+
exemptMilestones: false
22+
23+
# Set to true to ignore issues with an assignee (defaults to false)
24+
exemptAssignees: false
25+
26+
# Label to use when marking as stale
27+
staleLabel: abandoned
28+
29+
# Limit the number of actions per hour, from 1-30. Default is 30
30+
limitPerRun: 1
31+
32+
# Comment to post when removing the stale label.
33+
# unmarkComment: >
34+
# Your comment here.
35+
36+
# Optionally, specify configuration settings that are specific to just 'issues' or 'pulls':
37+
pulls:
38+
# Comment to post when marking as stale. Set to `false` to disable
39+
markComment: >
40+
This pull request has been automatically marked as abandoned because it has not had
41+
recent activity. It will be closed if no further activity occurs. Thank you
42+
for your contributions.
43+
44+
# Comment to post when closing a stale Pull Request.
45+
closeComment: >
46+
Please ping one of the maintainers once you commit the changes requested
47+
or make improvements on the code. If this is not the case and you need
48+
some help, feel free to ask for help in our [Gitter](https://gitter.im/TheAlgorithms)
49+
channel. Thank you for your contributions!
50+
51+
issues:
52+
# Comment to post when marking as stale. Set to `false` to disable
53+
markComment: >
54+
This issue has been automatically marked as abandoned because it has not had
55+
recent activity. It will be closed if no further activity occurs. Thank you
56+
for your contributions.
57+
58+
# Comment to post when closing a stale Issue.
59+
closeComment: >
60+
Please ping one of the maintainers once you add more information and updates here.
61+
If this is not the case and you need some help, feel free to ask for help
62+
in our [Gitter](https://gitter.im/TheAlgorithms) channel. Thank you for your contributions!

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@
66

77
This repository contains algorithms and data structures implemented in C# for eductional purposes.
88

9-
---
10-
119
## Overview
1210
* [Algorithms](./Algorithms/)
1311
* [Data Compression](<./Algorithms/DataCompression>)
@@ -125,8 +123,10 @@ This repository contains algorithms and data structures implemented in C# for ed
125123
* [Linked List](./DataStructures/LinkedList)
126124
* [Singly Linked List](./DataStructures/LinkedList/SinglyLinkedList/SinglyLinkedList.cs)
127125
* [Doubly Linked List](./DataStructures/LinkedList/DoublyLinkedList/DoublyLinkedList.cs)
128-
---
129126

130-
## Contribution
127+
## Contributing
131128

132-
You can contribute with pleasure to this repository. Please orient on the directory structure and overall code style of this repository. If you want to ask a question or suggest something, please open an issue.
129+
You can contribute with pleasure to this repository.
130+
Please orient on the directory structure and overall code style of this repository
131+
and refer to [our contributing guidelines](./CONTRIBUTING.md) for more detail.
132+
If you want to ask a question or suggest something, please open an issue.

0 commit comments

Comments
 (0)