Skip to content

Commit 9ef8dad

Browse files
joaoborksjoaoborks
committed
update docs
1 parent 67e810c commit 9ef8dad

File tree

7 files changed

+306
-672
lines changed

7 files changed

+306
-672
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
name: Bug Report
2+
description: Report a bug or unexpected behavior
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
## Bug Report
9+
Please provide as much detail as possible to help us identify and fix the issue.
10+
- type: input
11+
id: summary
12+
attributes:
13+
label: Summary
14+
description: A brief summary of the bug
15+
placeholder: "Scene transition freezes..."
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: steps
20+
attributes:
21+
label: Steps to Reproduce
22+
description: Steps to reproduce the issue
23+
placeholder: |
24+
1. Load scene A
25+
2. Transition to scene B
26+
3. Observe the freeze
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: expected
31+
attributes:
32+
label: Expected Behavior
33+
description: What did you expect to happen?
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: actual
38+
attributes:
39+
label: Actual Behavior
40+
description: What actually happened?
41+
validations:
42+
required: true
43+
- type: input
44+
id: version
45+
attributes:
46+
label: Advanced Scene Manager Version
47+
description: The version of the package you are using
48+
placeholder: "e.g., 3.1.0"
49+
validations:
50+
required: true
51+
- type: input
52+
id: editorversion
53+
attributes:
54+
label: Unity Editor Version
55+
description: The version of the Unity Editor you are using
56+
placeholder: "e.g., 6000.0.40f1"
57+
validations:
58+
required: true
59+
- type: textarea
60+
id: logs
61+
attributes:
62+
label: Logs
63+
description: Please attach any relevant logs or errors
64+
render: shell
65+
- type: checkboxes
66+
id: terms
67+
attributes:
68+
label: Acknowledgement
69+
options:
70+
- label: I have searched the existing issues to avoid duplicates
71+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Feature Request
2+
description: Suggest an idea or enhancement
3+
labels: ["enhancement"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
## Feature Request
9+
Have a feature idea? Let us know what you'd like to see in the Advanced Scene Manager!
10+
- type: input
11+
id: summary
12+
attributes:
13+
label: Summary
14+
description: A brief summary of the feature
15+
placeholder: "Add support for async scene loading with progress callbacks"
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: problem
20+
attributes:
21+
label: Problem or Use Case
22+
description: What problem would this feature solve? How would it be useful?
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: proposal
27+
attributes:
28+
label: Proposed Solution
29+
description: Describe how you'd like the feature to work
30+
validations:
31+
required: true
32+
- type: checkboxes
33+
id: terms
34+
attributes:
35+
label: Acknowledgement
36+
options:
37+
- label: I have searched the existing issues to ensure this feature hasn't been requested already
38+
required: true

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Question
2+
description: Ask a question or request help
3+
labels: ["question"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
## Question or Support Request
9+
Need help or have a question about using the Advanced Scene Manager? Let us know!
10+
- type: textarea
11+
id: question
12+
attributes:
13+
label: Your Question
14+
description: Clearly describe your question or the help you need
15+
validations:
16+
required: true
17+
- type: input
18+
id: version
19+
attributes:
20+
label: Advanced Scene Manager Version
21+
description: The version of the package you are using
22+
placeholder: "e.g., 3.1.0"
23+
validations:
24+
required: true
25+
- type: input
26+
id: editorversion
27+
attributes:
28+
label: Unity Editor Version
29+
description: The version of the Unity Editor you are using
30+
placeholder: "e.g., 6000.0.40f1"
31+
validations:
32+
required: true
33+
- type: checkboxes
34+
id: terms
35+
attributes:
36+
label: Acknowledgement
37+
options:
38+
- label: I have searched the documentation and existing issues
39+
required: true

‎CODE_OF_CONDUCT.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We, as contributors and maintainers of Advanced Scene Manager, pledge to make participation in our project and community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socioeconomic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
We are committed to fostering an open, welcoming, and inclusive community.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contribute to a positive environment include:
12+
13+
- Being respectful and inclusive of differing viewpoints and experiences.
14+
- Giving and gracefully accepting constructive feedback.
15+
- Using welcoming and inclusive language.
16+
- Focusing on what is best for the community.
17+
- Showing empathy towards other community members.
18+
19+
Examples of unacceptable behavior include:
20+
21+
- The use of sexualized language or imagery, or unwelcome sexual attention or advances.
22+
- Trolling, insulting or derogatory comments, and personal or political attacks.
23+
- Public or private harassment.
24+
- Publishing others’ private information without explicit permission.
25+
- Other conduct which could reasonably be considered inappropriate in a professional setting.
26+
27+
## Our Responsibilities
28+
29+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
30+
31+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct, or to ban temporarily or permanently any contributor for behaviors they deem inappropriate, threatening, offensive, or harmful.
32+
33+
## Scope
34+
35+
This Code of Conduct applies within all project spaces, including GitHub issues, pull requests, discussions, and any other communication channels used by the project. It also applies to public spaces when an individual is representing the project or its community.
36+
37+
Examples of representing the project include using an official project email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
38+
39+
## Enforcement
40+
41+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project maintainers via GitHub issues or direct contact. All complaints will be reviewed and investigated promptly and fairly.
42+
43+
Project maintainers are obligated to maintain the confidentiality of the reporter of an incident.
44+
45+
## Attribution
46+
47+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1.

‎CONTRIBUTING.md‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Contribution Guide
2+
3+
Thank you for considering contributing to Advanced Scene Manager! Whether you're fixing a bug, adding a feature, or improving the documentation, your contributions are greatly appreciated and help make the tool better for everyone.
4+
5+
## How to Contribute
6+
7+
There are several ways you can contribute to Advanced Scene Manager:
8+
9+
### 1. Reporting Issues
10+
11+
If you encounter any bugs or have feedback on features, please report them by opening an issue. When reporting an issue, please provide as much detail as possible, including:
12+
13+
- Steps to reproduce the bug (if applicable)
14+
- What behavior you expected and what actually happened
15+
- Any relevant error messages or logs
16+
17+
### 2. Submitting Code Changes
18+
19+
If you'd like to submit code to fix an issue or add a feature, please follow these steps:
20+
21+
#### Fork the Repository
22+
23+
- Navigate to the repository on GitHub.
24+
- Click the Fork button in the upper-right corner to create a copy of the repository under your GitHub account.
25+
26+
#### Clone Your Fork
27+
28+
Clone your forked repository to your local machine:
29+
30+
```bash
31+
git clone https://github.com/your-username/advanced-scene-manager.git
32+
```
33+
34+
#### Create a New Branch
35+
36+
Create a new branch for your feature or bug fix:
37+
38+
```bash
39+
git checkout -b feature-name-or-bugfix
40+
```
41+
42+
#### Make Your Changes
43+
44+
Make your changes to the code or documentation. When working on code:
45+
46+
- Follow the existing coding style and conventions.
47+
- Make sure to write unit tests for new features or bug fixes if applicable.
48+
49+
For documentation changes, the documentation resides in the `docs` branch of the repository. You can switch to this branch if you're only updating the docs or contributing to new documentation.
50+
51+
#### Create a Pull Request
52+
53+
Open a pull request from your fork to the main repository. In the PR description, provide a clear explanation of what you've done, the issue it addresses, and any relevant details.
54+
55+
- For code changes, the PR should be made against the main branch.
56+
- For documentation changes, the PR should be made against the `docs` branch.
57+
58+
This allows us to keep the documentation and code contributions in their respective branches.
59+
Documentation changes can be submitted in the same way as code changes, by creating a PR from your fork.
60+
61+
### 3. Improving Documentation
62+
63+
We welcome any improvements to the documentation as well. If you spot a typo or think something could be explained better, feel free to submit a pull request with the suggested changes!
64+
65+
### 4. Feature Requests
66+
67+
If you have an idea for a new feature, open an issue and describe the feature in detail. Be sure to explain why you think it would be valuable for other users. If you plan to implement the feature yourself, let us know in the issue before you start so we can discuss the approach.
68+
69+
## Code of Conduct
70+
71+
By contributing to this project, you agree to adhere to our [Code of Conduct](./CODE_OF_CONDUCT.md). Please treat everyone with respect and kindness.
72+
73+
## License
74+
75+
By submitting a pull request, you agree that your contributions will be licensed under the same license as the rest of the project ([MIT License](./LICENSE)).

0 commit comments

Comments
 (0)