Skip to content

Commit f731d4a

Browse files
committed
Initial commit
1 parent c444d66 commit f731d4a

File tree

88 files changed

+2676
-2
lines changed

Some content is hidden

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

88 files changed

+2676
-2
lines changed

.editorconfig

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
;
2+
; Global Editor Config for Adaptive Labbers
3+
;
4+
; This is an ini style configuration. See http://editorconfig.org/ for more information on this file.
5+
;
6+
; Top level editor config.
7+
root = true
8+
9+
; Always use Unix style new lines with new line ending on every file and trim whitespace
10+
[*]
11+
charset = utf-8 # added
12+
end_of_line = lf
13+
insert_final_newline = true
14+
trim_trailing_whitespace = true
15+
; Python: PEP8 defines 4 spaces for indentation
16+
[*.py]
17+
indent_style = space
18+
indent_size = 4
19+
; Salt state files, YAML format, 2 spaces
20+
[*.sls, *.yaml, *.yml]
21+
indent_style = space
22+
indent_size = 2

.gitattributes

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Set default behaviour, in case users don't have core.autocrlf set.
2+
* text=auto
3+
# Explicitly declare text files we want to always be normalized and converted
4+
# to native line endings on checkout.
5+
*.md text diff=markdown
6+
*.json.br filter=lfs diff=lfs merge=lfs -text

.github/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
**/.DS_Store

.github/FUNDING.yml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
github: scape-foundation
2+
patreon: scapefoundation
3+
custom: ['paypal.me/scapefoundation']

.github/ISSUE_TEMPLATE/bug_report.yml

+85
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
name: 🐞 Bug or error report
2+
description: Report an anomaly or unexpected behavior with a feature from this repository.
3+
labels: ['Needs: Triage :mag:', 'type:bug-suspected']
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
- [x] Bug
10+
11+
Thank you for reporting a bug! Use the sections below to submit a bug **only** if it's related to features in this repo.
12+
13+
- All bug reports are welcome - we want to fix them!
14+
- This repo is maintained by volunteers. Please be courteous and patient. 🙂
15+
- Remember to include sufficient details and context.
16+
- If you have multiple questions, suggestions, or bugs, please submit them in separate issues.
17+
- We accept pull requests. If you know how to fix it - go ahead!
18+
19+
20+
Please provide the following details about the issue you encountered. *Issues that do not provide the information requested in this form will be flagged as **incomplete** & automatically closed.*
21+
22+
- type: input
23+
id: feature
24+
validations:
25+
required: true
26+
attributes:
27+
label: Sample
28+
description: |
29+
Which feature are you having troubles with?
30+
31+
Use the feature name or URL. We don't want to be spend all this time diagnosing issues about the wrong feature, do we?
32+
33+
- type: input
34+
id: authors
35+
validations:
36+
required: true
37+
attributes:
38+
label: Author(s)
39+
description: |
40+
Who wrote the feature?
41+
42+
Because of the way this repository is configured, features authors do not get a notification when you create an issue.
43+
44+
For the section above **@mention any author of the feature**. Authors' GitHub handle can be found on the main feature documentation page, under the "Solution" section.
45+
46+
Issues without an @mention will be closed automatically, as authors won't get notified.
47+
48+
**NOTE:** Don't @mention the repo maintainers, they already get notified.
49+
50+
- type: markdown
51+
attributes:
52+
value: |
53+
Provide a clear & concise description of what the bug is.
54+
55+
**Do not attach ZIP files** of your code or compiled projects - instead, please publish your code to a public GitHub repo & post a link to it.
56+
57+
- type: textarea
58+
id: what-happened
59+
attributes:
60+
label: What happened?
61+
description: Describe the observed behavior
62+
placeholder: Tell us what you see!
63+
validations:
64+
required: true
65+
66+
- type: textarea
67+
id: steps
68+
attributes:
69+
label: Steps to reproduce
70+
description: How do you reproduce this? Please provide as much step-by-step detail as possible.
71+
value: |
72+
1.
73+
2.
74+
3.
75+
validations:
76+
required: true
77+
78+
- type: textarea
79+
id: expected
80+
attributes:
81+
label: Expected behavior
82+
description: What did you expect to happen when the reproduce steps are followed?
83+
placeholder: Tell us what you expected to see!
84+
validations:
85+
required: true

.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: Start a discussion
4+
about: 🗨 Start a friendly conversation with the other members of the community about the samples in this repository.
5+
url: https://github.com/scape-foundation/earth-txt/discussions
+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: "\U0001F9EA Feature request"
2+
description: Request a new feature from the community
3+
labels: ['Needs: Triage :mag:', 'type:feature-request', 'Help wanted 🪧']
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
10+
Thank you for making a request! Use the sections below to submit a request **only** for a new feature.
11+
12+
- Requests that do not follow the below template will automatically be closed
13+
- All requests are welcome - the more the merrier!
14+
- This repo is maintained by volunteers. Please be courteous and patient. 🙂
15+
- Remember to include sufficient details and context.
16+
- If you have multiple requests submit them separately so we can track resolution.
17+
- We accept pull requests. If you know how to make it - go ahead!
18+
19+
- type: textarea
20+
id: description
21+
attributes:
22+
label: Sample description
23+
description: What should the feature do?
24+
placeholder: Tell us what you want, what you really, really want.
25+
validations:
26+
required: true
27+
28+
- type: dropdown
29+
id: willing-to-help
30+
attributes:
31+
label: Are you willing to help?
32+
description: Would you be willing to help whoever decides to take this on?
33+
options:
34+
- "Yes"
35+
- "No"
36+
validations:
37+
required: true

.github/ISSUE_TEMPLATE/question.yml

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: ❓ Question
2+
description: Ask a question about one of our features
3+
labels: ['Needs: Triage :mag:', 'type:question']
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
10+
Thank you for asking a question! Use the sections below to submit a question **only** if it's related to features in this repo.
11+
12+
- Questions that do not follow the below template will automatically be closed
13+
- Don't use questions to diagnose issues with features, that's what [bug reports](https://github.com/scape-foundation/earth-txt/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&template=bug_report.yml) are for!
14+
- All questions are welcome - let us know what's on your mind!
15+
- This repo is maintained by volunteers. Please be courteous and patient. 🙂
16+
- Remember to include sufficient details and context.
17+
- If you have multiple questions please submit them separately so we can track resolution.
18+
- Screenshots are always helpful (just paste any images right here in the question)
19+
- If you're trying to start a conversation on a topic, consider using [Discussions](https://github.com/scape-foundation/earth-txt/discussions). We want to close every issue as quickly as possible, but discussions are intended for longer conversations.
20+
21+
- type: input
22+
id: feature
23+
validations:
24+
required: true
25+
attributes:
26+
label: Sample
27+
description: |
28+
Which feature are you talking about
29+
30+
Use the feature name or URL.
31+
32+
- type: input
33+
id: authors
34+
validations:
35+
required: true
36+
attributes:
37+
label: Author(s)
38+
description: |
39+
Who wrote the feature?
40+
41+
Because of the way this repository is configured, features authors do not get a notification when you create an issue.
42+
43+
For the section above **@mention any author of the feature**. Authors' GitHub handle can be found on the main feature documentation page, under the "Solution" section.
44+
45+
Questions without an @mention will automatically be closed, because authors won't get notified.
46+
47+
**NOTE:** Don't @mention the repo maintainers, they already get notified.
48+
49+
- type: textarea
50+
id: question
51+
attributes:
52+
label: Question
53+
description: What would you like to know?
54+
placeholder: The more details, the better
55+
validations:
56+
required: true

.github/ISSUE_TEMPLATE/suggestion.yml

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: 💡 Suggestion
2+
description: Suggest an enhancement to make one of our features even better
3+
labels: ['Needs: Triage :mag:', 'type:enhancement']
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
10+
Thank you for your suggestion! Use the sections below to submit a suggestion **only** if it's related to features in this repo.
11+
12+
- Suggestions that do not follow the below template will automatically be closed
13+
- All ideas are welcome - let's build something together!
14+
- This repo is maintained by volunteers. Please be courteous and patient. 🙂
15+
- Remember to include sufficient details and context.
16+
- If you have multiple suggestions please submit them separately so we can track resolution.
17+
- Screenshots are always helpful (just paste any images right here in the suggestion)
18+
19+
- type: input
20+
id: feature
21+
validations:
22+
required: true
23+
attributes:
24+
label: Sample
25+
description: |
26+
Which feature are you talking about
27+
28+
Use the feature name or URL.
29+
30+
- type: input
31+
id: authors
32+
validations:
33+
required: true
34+
attributes:
35+
label: Author(s)
36+
description: |
37+
Who wrote the feature?
38+
39+
Because of the way this repository is configured, features authors do not get a notification when you create an issue.
40+
41+
For the section above **@mention any author of the feature**. Authors' GitHub handle can be found on the main feature documentation page, under the "Solution" section.
42+
43+
**NOTE:** Don't @mention the repo maintainers, they already get notified.
44+
45+
- type: textarea
46+
id: suggestion
47+
attributes:
48+
label: Suggestion
49+
description: What would you like to see improved?
50+
placeholder: The more details, the better
51+
validations:
52+
required: true
53+
54+
55+
- type: dropdown
56+
id: willing-to-help
57+
attributes:
58+
label: Are you willing to help?
59+
description: Would you be willing to help us make this improvement?
60+
options:
61+
- "Yes"
62+
- "No"
63+
validations:
64+
required: true

.github/PULL_REQUEST_TEMPLATE.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
> By submitting this pull request, you agree to the [contribution guidelines](CONTRIBUTING.md)
2+
3+
4+
| Q | A |
5+
| --------------- | --------------------------------------- |
6+
| Bug fix? | no - yes? |
7+
| New feature? | no - yes? |
8+
| New sample? | no - yes? |
9+
| Related issues? | fixes #X, partially #Y, mentioned in #Z |
10+
11+
## What's in this Pull Request?
12+
13+
> Please describe the changes in this PR. Sample description or details around bugs which are being fixed.
14+
>
15+
> _(DELETE THIS PARAGRAPH AFTER READING)_
16+
17+
## Submitter Guidance (DELETE AFTER READING)
18+
>
19+
> *Please update this PR information accordingly. We'll use this as part of our release notes in monthly communications.*
20+
>
21+
> *Pull requests that do not follow this template will be automatically rejected.*
22+
>
23+
> *Please target your PR to `main` branch.*
24+
>
25+
> *Remember that this repository is maintained by community members who volunteer their time to help. Be courteous and patient.*
26+
> _(DELETE THIS SECTION AFTER READING)_

0 commit comments

Comments
 (0)