Skip to content

Commit dcf98b2

Browse files
authored
Merge pull request #389 from kimdv/kimdv/update-readme
Update contribution
2 parents 567acb5 + 7b715b3 commit dcf98b2

File tree

4 files changed

+94
-1
lines changed

4 files changed

+94
-1
lines changed

.github/ISSUE_TEMPLATE/BUG_REPORT.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug Report
3+
about: Something isn't working as expected
4+
labels: bug
5+
---
6+
7+
<!--
8+
Thank you for contributing to SwiftSyntax!
9+
10+
Before you submit your issue, please replace each paragraph
11+
below with the relevant details for your bug, and complete
12+
the steps in the checklist by placing an 'x' in each box:
13+
14+
- [x] I've completed this task
15+
- [ ] This task isn't completed
16+
-->
17+
18+
Replace this paragraph with a short description of the incorrect behavior.
19+
If you think this issue has been recently introduced and did not occur in an
20+
earlier version, please note that. If possible, include the last version that
21+
the behavior was correct in addition to your current version.
22+
23+
### Checklist
24+
25+
- [ ] If possible, I've reproduced the issue using the `main` branch of this package.
26+
- [ ] This issue hasn't been addressed in an [existing GitHub issue](https://github.com/apple/swift-syntax/issues).
27+
28+
### Expected behavior
29+
30+
Describe what you expected to happen.
31+
32+
### Actual behavior
33+
34+
Describe or copy/paste the behavior you observe.
35+
36+
### Steps to Reproduce
37+
38+
Replace this paragraph with an explanation of how to reproduce the incorrect behavior.
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Feature Request
3+
about: A suggestion for a new feature
4+
labels: enhancement
5+
---
6+
7+
<!--
8+
Thank you for contributing to SwiftSyntax!
9+
Before you submit your issue, please replace each paragraph
10+
below with information about your proposed feature.
11+
-->
12+
13+
### Feature Request: _<Feature Name>_
14+
15+
#### Description
16+
17+
Replace this paragraph with a description of your proposed feature.
18+
Sample that show what's missing, or what new capabilities will be possible, are very helpful!
19+
Provide links to existing issues or external references/discussions, if appropriate.
20+
21+
#### Motivation
22+
23+
Replace this paragraph with a description of the use-case this proposal is trying to serve.
24+
25+
#### Importance
26+
27+
Replace this paragraph with a description of the importance of this change.
28+
Does this feature unlock entirely new use-cases?
29+
Or is it possible to achieve the same functionality with existing functionality
30+
and this change would improve the user experience?
31+
32+
#### Alternatives Considered
33+
34+
If you considered alternative approaches for this feature, please include them here.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# This source file is part of the Swift.org open source project
2+
#
3+
# Copyright (c) 2022 Apple Inc. and the Swift project authors
4+
# Licensed under Apache License v2.0 with Runtime Library Exception
5+
#
6+
# See https://swift.org/LICENSE.txt for license information
7+
# See https://swift.org/CONTRIBUTORS.txt for Swift project authors
8+
9+
# This is set to `false` to encourage users to use the provided templates instead
10+
# of beginning with a blank one.
11+
#
12+
# For details, see: https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
13+
blank_issues_enabled: false
14+
15+
contact_links:
16+
- name: Discussion Forum
17+
url: https://forums.swift.org/tags/c/development/tooling/39/swift-syntax
18+
about: Ask and answer questions about SwiftSyntax
19+
- name: SwiftSyntax Documentation
20+
url: https://github.com/apple/swift-syntax/tree/main/Documentation
21+
about: Learn about how to use the SwiftSyntax in your projects

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Start contributing to SwiftSyntax see [this guide](https://github.com/apple/swif
5151

5252
## Reporting Issues
5353

54-
If you should hit any issues while using SwiftSyntax, we appreciate bug reports on [bugs.swift.org](https://bugs.swift.org) in the [SwiftSyntax component](https://bugs.swift.org/issues/?jql=component%20%3D%20SwiftSyntax).
54+
If you should hit any issues while using SwiftSyntax, we appreciate bug reports on [GitHub Issue](https://github.com/apple/swift-syntax/issues).
5555

5656
## License
5757

0 commit comments

Comments
 (0)