-
Notifications
You must be signed in to change notification settings - Fork 61
add issue & PR template #80
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| --- | ||
| name: ERC Compatibility Issue | ||
| about: Report ERC standard compliance or interoperability issues | ||
| title: '[ERC Compatibility]: ' | ||
| labels: ['compatibility'] | ||
| assignees: '' | ||
| --- | ||
|
|
||
| Please look through our [CONTRIBUTING](https://github.com/Perfect-Abstractions/Compose/blob/main/CONTRIBUTING.md) guide, [discussions](https://github.com/Perfect-Abstractions/Compose/discussions) and codebase to ensure your issue is well-researched and not already covered. | ||
|
|
||
| ## ERC Compatibility Issue | ||
|
|
||
| **Help us maintain ERC standard compliance and interoperability:** | ||
|
|
||
| ### Standard/Interface | ||
| <!-- Which ERC standard or interface is involved? (e.g., ERC-20, ERC-721, ERC-173, other) --> | ||
|
|
||
| ### Summary | ||
| <!-- Provide a brief summary of the compatibility issue --> | ||
|
|
||
| ### Recommended change | ||
| <!-- Describe a possible change to the code --> | ||
|
|
||
| ### Additional Context | ||
| <!-- Add any other context, links, screenshots, or information that might be helpful --> | ||
|
|
||
| ## Helpful Information | ||
|
|
||
| **Have a question?** Please check our [CONTRIBUTING](https://github.com/Perfect-Abstractions/Compose/blob/main/CONTRIBUTING.md) file first - your answer might already be there! | ||
|
|
||
| **Want to discuss something?** For general questions, ideas, or brainstorming, please browse our [discussions](https://github.com/Perfect-Abstractions/Compose/discussions) or start a new one. | ||
|
|
||
| You can also join our [Discord](https://discord.gg/DCBD2UKbxc) to discuss the compatibility issue. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| blank_issues_enabled: false | ||
| contact_links: | ||
| - name: GitHub Discussions | ||
| url: https://github.com/Perfect-Abstractions/Compose/discussions | ||
| about: Ask questions, share ideas, and discuss the project | ||
| - name: Discord Community | ||
| url: https://discord.gg/DCBD2UKbxc | ||
| about: Join our Discord for real-time discussions and support | ||
| - name: Contributing | ||
| url: https://github.com/Perfect-Abstractions/Compose/blob/main/CONTRIBUTING.md | ||
| about: Read the contributing guide to get started |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| --- | ||
| name: Documentation Issue | ||
| about: Report documentation problems or suggest improvements | ||
| title: '[DOCS] ' | ||
| labels: ['documentation'] | ||
| assignees: '' | ||
| --- | ||
|
|
||
| Please look through our [CONTRIBUTING](https://github.com/Perfect-Abstractions/Compose/blob/main/CONTRIBUTING.md) guide, [discussions](https://github.com/Perfect-Abstractions/Compose/discussions) and codebase to ensure your issue is well-researched and not already covered. | ||
|
|
||
| ## Documentation Issue | ||
|
|
||
| **Help us improve our documentation by reporting issues or suggesting improvements:** | ||
|
|
||
| ### Summary | ||
| <!-- Describe the documentation issue clearly --> | ||
|
|
||
| ### Location | ||
| <!-- Provide links, file paths, or section names --> | ||
|
|
||
| ### Recommended change | ||
| <!-- Describe what the correct information should be --> | ||
|
|
||
| ### Additional Context | ||
| <!-- Add any other context, screenshots, or examples that might be helpful --> | ||
|
|
||
| ## Helpful Information | ||
|
|
||
| **Have a question?** Please check our [CONTRIBUTING](https://github.com/Perfect-Abstractions/Compose/blob/main/CONTRIBUTING.md) file first - your answer might already be there! | ||
|
|
||
| **Want to discuss something?** For general questions, ideas, or brainstorming, please browse our [discussions](https://github.com/Perfect-Abstractions/Compose/discussions) or start a new one. | ||
|
|
||
| You can also join our [Discord](https://discord.gg/DCBD2UKbxc) to discuss the documentation issue. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| --- | ||
| name: Feature Request | ||
| about: Suggest an idea for this project | ||
| title: '[Feature]: ' | ||
| labels: ['new feature'] | ||
| assignees: '' | ||
| --- | ||
|
|
||
| Please look through our [CONTRIBUTING](https://github.com/Perfect-Abstractions/Compose/blob/main/CONTRIBUTING.md) guide, [discussions](https://github.com/Perfect-Abstractions/Compose/discussions) and codebase to ensure your issue is well-researched and not already covered. | ||
|
|
||
| ## Feature Request | ||
|
|
||
|
|
||
| **If you have an idea for a new feature or improvement, please provide enough detail to help us understand your request.** | ||
|
|
||
| ### Description | ||
| <!-- A clear and concise description of the feature you propose --> | ||
|
|
||
| ### Value | ||
| <!-- Explain the problem this feature would solve or the benefit it would provide --> | ||
|
|
||
|
|
||
| ### Additional Context | ||
| <!-- Add any other context, links or information that might be helpful --> | ||
|
|
||
| ## Helpful Information | ||
|
|
||
| **Have a question?** Please check our [CONTRIBUTING](https://github.com/Perfect-Abstractions/Compose/blob/main/CONTRIBUTING.md) file first - your answer might already be there! | ||
|
|
||
| **Want to discuss something?** For general questions, ideas, or brainstorming, please browse our [discussions](https://github.com/Perfect-Abstractions/Compose/discussions) or start a new one. | ||
|
|
||
| You can also join our [Discord](https://discord.gg/DCBD2UKbxc) to discuss the issue. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| --- | ||
| name: Question | ||
| about: Ask a question about the project | ||
| title: '[QUESTION] ' | ||
| labels: ['question'] | ||
| assignees: '' | ||
| --- | ||
|
|
||
| Please look through our [CONTRIBUTING](https://github.com/Perfect-Abstractions/Compose/blob/main/CONTRIBUTING.md) guide, [discussions](https://github.com/Perfect-Abstractions/Compose/discussions) and codebase to ensure your issue is well-researched and not already covered. | ||
|
|
||
| ## Question | ||
|
|
||
| **What would you like to know about Compose?** | ||
|
|
||
| ### Your Question | ||
| <!-- Ask your question in a clear and concise way --> | ||
|
|
||
| ### Context | ||
| <!-- Provide any relevant context or background information --> | ||
|
|
||
| ### What I've Tried | ||
| <!-- Describe what you've already tried or researched --> | ||
|
|
||
| ### Expected Outcome | ||
| <!-- What would help you the most? --> | ||
|
|
||
| ### Code Example | ||
| <!-- If applicable, provide a code example that relates to your question --> | ||
|
|
||
| ## Helpful Information | ||
|
|
||
| **Have a question?** Please check our [README](https://github.com/Perfect-Abstractions/Compose/blob/main/README.md) and [CONTRIBUTING](https://github.com/Perfect-Abstractions/Compose/blob/main/CONTRIBUTING.md) files first - your answer might already be there! | ||
|
|
||
| **Want to discuss something?** For general questions, ideas, or brainstorming, please browse our [discussions](https://github.com/Perfect-Abstractions/Compose/discussions) or start a new one. | ||
|
|
||
| You can also join our [Discord](https://discord.gg/DCBD2UKbxc) to discuss the question. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| --- | ||
| name: Security Issue | ||
| about: Report a security vulnerability | ||
| title: '[SECURITY] ' | ||
| labels: ['security'] | ||
| assignees: '' | ||
| --- | ||
|
|
||
| Please look through our [CONTRIBUTING](https://github.com/Perfect-Abstractions/Compose/blob/main/CONTRIBUTING.md) guide, [discussions](https://github.com/Perfect-Abstractions/Compose/discussions) and codebase to ensure your issue is well-researched and not already covered. | ||
|
|
||
| ## Security Issue | ||
|
|
||
| ### Vulnerability Description | ||
| <!-- Describe the security issue clearly and concisely --> | ||
|
|
||
| ### Impact | ||
| <!-- What is the potential impact of this vulnerability? --> | ||
|
|
||
| ### Code Example | ||
| <!-- If applicable, provide a minimal code example that demonstrates the vulnerability --> | ||
|
|
||
| ### Suggested Fix | ||
| <!-- If you have ideas for how to fix this, please describe them --> | ||
|
|
||
| ### Additional Context | ||
| <!-- Add any other context, proof of concept, or information that might be helpful --> | ||
|
|
||
| ## Helpful Information | ||
|
|
||
| **Security is our top priority.** We appreciate responsible disclosure of security issues. | ||
|
|
||
| **Have a question?** Please check our [CONTRIBUTING](https://github.com/Perfect-Abstractions/Compose/blob/main/CONTRIBUTING.md) file first - your answer might already be there! | ||
|
|
||
| **Want to discuss something?** For general questions, ideas, or brainstorming, please browse our [discussions](https://github.com/Perfect-Abstractions/Compose/discussions) or start a new one. | ||
|
|
||
| You can also join our [Discord](https://discord.gg/DCBD2UKbxc) to discuss security concerns. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| --- | ||
| name: Testing Issue | ||
| about: Report test-related problems or suggest test improvements | ||
| title: '[Testing]: ' | ||
| labels: ['testing'] | ||
| assignees: '' | ||
| --- | ||
|
|
||
| Please look through our [CONTRIBUTING](https://github.com/Perfect-Abstractions/Compose/blob/main/CONTRIBUTING.md) guide, [discussions](https://github.com/Perfect-Abstractions/Compose/discussions) and codebase to ensure your issue is well-researched and not already covered. | ||
|
|
||
| ## Testing Issue | ||
|
|
||
|
|
||
|
|
||
| **Help us improve our test coverage and quality:** | ||
|
|
||
| ### Description | ||
| <!-- A clear and concise description of the testing issue --> | ||
|
|
||
| ### Target File/Function(s) being tested | ||
| <!-- Which file or function is being tested? --> | ||
|
|
||
| ## Helpful Information | ||
|
|
||
| **Have a question?** Please check our [CONTRIBUTING](https://github.com/Perfect-Abstractions/Compose/blob/main/CONTRIBUTING.md) file first - your answer might already be there! | ||
|
|
||
| **Want to discuss something?** For general questions, ideas, or brainstorming, please browse our [discussions](https://github.com/Perfect-Abstractions/Compose/discussions) or start a new one. | ||
|
|
||
| You can also join our [Discord](https://discord.gg/DCBD2UKbxc) to discuss the testing issue. | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| ## Summary | ||
| <!-- Provide a brief summary of your changes --> | ||
|
|
||
| ## Changes Made | ||
|
|
||
| <!-- List the main changes you made --> | ||
|
|
||
| ## Checklist | ||
|
|
||
| Before submitting this PR, please ensure: | ||
|
|
||
| [ ] **Code follows the Solidity feature ban** - No inheritance, constructors, modifiers, public/private variables, external library functions, `using for` directives, or `selfdestruct` | ||
|
|
||
| [ ] **Code follows Design Principles** - Readable, uses diamond storage, favors composition over inheritance | ||
|
|
||
| [ ] **Code matches ERC20Facet.sol style** - Consistent formatting, documentation, and patterns | ||
|
|
||
| [ ] **Code is formatted with `forge fmt`** | ||
|
|
||
| [ ] **Tests are included** - All new functionality has comprehensive tests | ||
|
|
||
| [ ] **All tests pass** - Run `forge test` and ensure everything works | ||
|
|
||
| [ ] **Documentation updated** - If applicable, update relevant documentation | ||
|
|
||
| Make sure to follow the [CONTRIBUTING.md](https://github.com/Perfect-Abstractions/Compose/blob/main/CONTRIBUTING.md) guidelines. | ||
|
|
||
| ## Additional Notes | ||
|
|
||
| <!-- Any additional information, concerns, or questions for reviewers --> |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.