Skip to content

Commit 667fe2c

Browse files
rainxrainx
committed
docs: add necessary documents for GitHub open-source project
1 parent 9af3944 commit 667fe2c

9 files changed

+235
-0
lines changed

‎.github/ISSUE_TEMPLATE/01_BUG_REPORT.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help PHPDoc Parser to improve
4+
title: "bug: "
5+
labels: "bug"
6+
assignees: ""
7+
---
8+
9+
# Bug Report
10+
11+
**PHPDoc Parser version:**
12+
13+
<!-- Please specify commit or tag version. -->
14+
15+
**Current behavior:**
16+
17+
<!-- Describe how the bug manifests. -->
18+
19+
**Expected behavior:**
20+
21+
<!-- Describe what you expect the behavior to be without the bug. -->
22+
23+
**Steps to reproduce:**
24+
25+
<!-- Explain the steps required to duplicate the issue, especially if you are able to provide a sample application. -->
26+
27+
**Related code:**
28+
29+
<!-- If you are able to illustrate the bug or feature request with an example, please provide it here. -->
30+
31+
```
32+
insert short code snippets here
33+
```
34+
35+
**Other information:**
36+
37+
<!-- List any other information that is relevant to your issue. Related issues, suggestions on how to fix, Stack Overflow links, forum links, etc. -->

‎.github/ISSUE_TEMPLATE/02_FEATURE_REQUEST.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: "feat: "
5+
labels: "enhancement"
6+
assignees: ""
7+
---
8+
9+
# Feature Request
10+
11+
**Describe the Feature Request**
12+
13+
<!-- A clear and concise description of what the feature request is. Please include if your feature request is related to a problem. -->
14+
15+
**Describe Preferred Solution**
16+
17+
<!-- A clear and concise description of what you want to happen. -->
18+
19+
**Describe Alternatives**
20+
21+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
22+
23+
**Related Code**
24+
25+
<!-- If you are able to illustrate the bug or feature request with an example, please provide it here. -->
26+
27+
**Additional Context**
28+
29+
<!-- List any other information that is relevant to your issue. Stack traces, related issues, suggestions on how to add, use case, Stack Overflow links, forum links, screenshots, OS if applicable, etc. -->
30+
31+
**If the feature request is approved, would you be willing to submit a PR?**
32+
_(Help can be provided if you need assistance submitting a PR)_
33+
34+
- [ ] Yes
35+
- [ ] No

‎.github/ISSUE_TEMPLATE/03_CODEBASE_IMPROVEMENT.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: Codebase improvement
3+
about: Provide your feedback for the existing codebase. Suggest a better solution for algorithms, development tools, etc.
4+
title: "dev: "
5+
labels: "enhancement"
6+
assignees: ""
7+
---

‎.github/ISSUE_TEMPLATE/04_SUPPORT_QUESTION.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
name: Support Question
3+
about: Question on how to use this project
4+
title: "support: "
5+
labels: "question"
6+
assignees: ""
7+
---
8+
9+
# Support Question

‎.github/ISSUE_TEMPLATE/config.yml

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
---
2+
blank_issues_enabled: false

‎.github/PULL_REQUEST_TEMPLATE.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<!--- Please provide a general summary of your changes in the title above -->
2+
3+
## Pull Request type
4+
5+
<!-- Please try to limit your pull request to one type; submit multiple pull requests if needed. -->
6+
7+
Please check the type of change your PR introduces:
8+
9+
- [ ] Bugfix
10+
- [ ] Feature
11+
- [ ] Code style update (formatting, renaming)
12+
- [ ] Refactoring (no functional changes, no API changes)
13+
- [ ] Build-related changes
14+
- [ ] Documentation content changes
15+
- [ ] Other (please describe):
16+
17+
## What is the current behavior?
18+
19+
<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
20+
21+
Issue Number: N/A
22+
23+
## What is the new behavior?
24+
25+
<!-- Please describe the behavior or changes that are being added by this PR. -->
26+
27+
-
28+
-
29+
-
30+
31+
## Does this introduce a breaking change?
32+
33+
- [ ] Yes
34+
- [ ] No
35+
36+
<!-- If this does introduce a breaking change, please describe the impact and migration path for existing applications below. -->
37+
38+
## Other information
39+
40+
<!-- Any other information that is important to this PR, such as screenshots of how the component looks before and after the change. -->

‎docs/CODE_OF_CONDUCT.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
- Using welcoming and inclusive language
12+
- Being respectful of differing viewpoints and experiences
13+
- Gracefully accepting constructive criticism
14+
- Focusing on what is best for the community
15+
- Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
- Trolling, insulting/derogatory comments, and personal or political attacks
21+
- Public or private harassment
22+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
- Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
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.
28+
29+
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 to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community 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. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project maintainer(the address will be provided later). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
44+
45+
For answers to common questions about this code of conduct, see <https://www.contributor-covenant.org/faq>

‎docs/CONTRIBUTING.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Contributing
2+
3+
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
4+
Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
5+
6+
## Development environment setup
7+
8+
> **[?]**
9+
> Proceed to describe how to setup local development environment.
10+
> e.g:
11+
12+
To set up a development environment, please follow these steps:
13+
14+
1. Clone the repo
15+
16+
```sh
17+
git clone https://github.com/RightCapitalHQ/phpdoc-parser
18+
```
19+
20+
2. TODO
21+
22+
## Issues and feature requests
23+
24+
You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? You can help us by [submitting an issue on GitHub](https://github.com/RightCapitalHQ/phpdoc-parser/issues). Before you create an issue, make sure to search the issue archive -- your issue may have already been addressed!
25+
26+
Please try to create bug reports that are:
27+
28+
- _Reproducible._ Include steps to reproduce the problem.
29+
- _Specific._ Include as much detail as possible: which version, what environment, etc.
30+
- _Unique._ Do not duplicate existing opened issues.
31+
- _Scoped to a Single Bug._ One bug per report.
32+
33+
**Even better: Submit a pull request with a fix or new feature!**
34+
35+
### How to submit a Pull Request
36+
37+
1. Search our repository for open or closed
38+
[Pull Requests](https://github.com/RightCapitalHQ/phpdoc-parser/pulls)
39+
that relate to your submission. You don't want to duplicate effort.
40+
2. Fork the project
41+
3. Create your feature branch (`git checkout -b feature/amazing_feature`)
42+
4. Commit your changes (`git commit -m 'feat: add amazing_feature'`) PHPDoc Parser uses [conventional commits](https://www.conventionalcommits.org), so please follow the specification in your commit messages.
43+
5. Push to the branch (`git push origin feature/amazing_feature`)
44+
6. [Open a Pull Request](https://github.com/RightCapitalHQ/phpdoc-parser/compare?expand=1)

‎docs/SECURITY.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
If there are any vulnerabilities in **PHPDoc Parser**, don't hesitate to _report them_.
6+
7+
1. Use the (the address will be provided later).
8+
2. Describe the vulnerability.
9+
10+
If you have a fix, that is most welcome -- please attach or summarize it in your message!
11+
12+
3. We will evaluate the vulnerability and, if necessary, release a fix or mitigating steps to address it. We will contact you to let you know the outcome, and will credit you in the report.
13+
14+
Please **do not disclose the vulnerability publicly** until a fix is released!
15+
16+
4. Once we have either a) published a fix, or b) declined to address the vulnerability for whatever reason, you are free to publicly disclose it.

0 commit comments

Comments
 (0)