Skip to content

Commit

Permalink
Merge pull request #649 from phpDocumentor/docs/add-pr-templates
Browse files Browse the repository at this point in the history
TASK: add pull request templates for satilite libs
  • Loading branch information
jaapio authored Nov 2, 2023
2 parents 4d2334c + c253b99 commit 2766064
Show file tree
Hide file tree
Showing 12 changed files with 135 additions and 1 deletion.
1 change: 1 addition & 0 deletions packages/guides-cli/.gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
/docs export-ignore
/tests export-ignore
/.gitignore export-ignore
.github export-ignore
18 changes: 18 additions & 0 deletions packages/guides-cli/.github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Contribute to the phpDocumentor Guides

## Go to the mono-repository

This project is developed in the mono-repository `phpDocumentor Guides <https://github.com/phpDocumentor/guides>`__.
The repository you are currently in gets auto-created by splitting the mono-repository. You **must not** contribute
to this repository directly but always to the mono-repository linked above.

## Create Issues

* If you find something missing or something is wrong in this library, you are welcome to write an issue
describing the problem: `Issues on GitHub <https://github.com/phpDocumentor/guides/issues>`__.
* If you can, please try to fix the problem yourself.

# Make changes (create pull requests)

See the `Contribution chapter <https://github.com/phpDocumentor/guides/tree/main/docs/contributions/index.rst>`__ in the
`Documentation` <https://github.com/phpDocumentor/guides/tree/main/docs/index.rst>`__.
5 changes: 5 additions & 0 deletions packages/guides-code/.gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
/.gitattributes export-ignore
/docs export-ignore
/tests export-ignore
/.gitignore export-ignore
.github export-ignore
18 changes: 18 additions & 0 deletions packages/guides-code/.github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Contribute to the phpDocumentor Guides

## Go to the mono-repository

This project is developed in the mono-repository `phpDocumentor Guides <https://github.com/phpDocumentor/guides>`__.
The repository you are currently in gets auto-created by splitting the mono-repository. You **must not** contribute
to this repository directly but always to the mono-repository linked above.

## Create Issues

* If you find something missing or something is wrong in this library, you are welcome to write an issue
describing the problem: `Issues on GitHub <https://github.com/phpDocumentor/guides/issues>`__.
* If you can, please try to fix the problem yourself.

# Make changes (create pull requests)

See the `Contribution chapter <https://github.com/phpDocumentor/guides/tree/main/docs/contributions/index.rst>`__ in the
`Documentation` <https://github.com/phpDocumentor/guides/tree/main/docs/index.rst>`__.
1 change: 1 addition & 0 deletions packages/guides-graphs/.gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
/docs export-ignore
/tests export-ignore
/.gitignore export-ignore
.github export-ignore
18 changes: 18 additions & 0 deletions packages/guides-graphs/.github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Contribute to the phpDocumentor Guides

## Go to the mono-repository

This project is developed in the mono-repository `phpDocumentor Guides <https://github.com/phpDocumentor/guides>`__.
The repository you are currently in gets auto-created by splitting the mono-repository. You **must not** contribute
to this repository directly but always to the mono-repository linked above.

## Create Issues

* If you find something missing or something is wrong in this library, you are welcome to write an issue
describing the problem: `Issues on GitHub <https://github.com/phpDocumentor/guides/issues>`__.
* If you can, please try to fix the problem yourself.

# Make changes (create pull requests)

See the `Contribution chapter <https://github.com/phpDocumentor/guides/tree/main/docs/contributions/index.rst>`__ in the
`Documentation` <https://github.com/phpDocumentor/guides/tree/main/docs/index.rst>`__.
1 change: 1 addition & 0 deletions packages/guides-markdown/.gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
/docs export-ignore
/tests export-ignore
/.gitignore export-ignore
.github export-ignore
18 changes: 18 additions & 0 deletions packages/guides-markdown/.github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Contribute to the phpDocumentor Guides

## Go to the mono-repository

This project is developed in the mono-repository `phpDocumentor Guides <https://github.com/phpDocumentor/guides>`__.
The repository you are currently in gets auto-created by splitting the mono-repository. You **must not** contribute
to this repository directly but always to the mono-repository linked above.

## Create Issues

* If you find something missing or something is wrong in this library, you are welcome to write an issue
describing the problem: `Issues on GitHub <https://github.com/phpDocumentor/guides/issues>`__.
* If you can, please try to fix the problem yourself.

# Make changes (create pull requests)

See the `Contribution chapter <https://github.com/phpDocumentor/guides/tree/main/docs/contributions/index.rst>`__ in the
`Documentation` <https://github.com/phpDocumentor/guides/tree/main/docs/index.rst>`__.
18 changes: 18 additions & 0 deletions packages/guides-restructured-text/.github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Contribute to the phpDocumentor Guides

## Go to the mono-repository

This project is developed in the mono-repository `phpDocumentor Guides <https://github.com/phpDocumentor/guides>`__.
The repository you are currently in gets auto-created by splitting the mono-repository. You **must not** contribute
to this repository directly but always to the mono-repository linked above.

## Create Issues

* If you find something missing or something is wrong in this library, you are welcome to write an issue
describing the problem: `Issues on GitHub <https://github.com/phpDocumentor/guides/issues>`__.
* If you can, please try to fix the problem yourself.

# Make changes (create pull requests)

See the `Contribution chapter <https://github.com/phpDocumentor/guides/tree/main/docs/contributions/index.rst>`__ in the
`Documentation` <https://github.com/phpDocumentor/guides/tree/main/docs/index.rst>`__.
18 changes: 18 additions & 0 deletions packages/guides-theme-bootstrap/.github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Contribute to the phpDocumentor Guides

## Go to the mono-repository

This project is developed in the mono-repository `phpDocumentor Guides <https://github.com/phpDocumentor/guides>`__.
The repository you are currently in gets auto-created by splitting the mono-repository. You **must not** contribute
to this repository directly but always to the mono-repository linked above.

## Create Issues

* If you find something missing or something is wrong in this library, you are welcome to write an issue
describing the problem: `Issues on GitHub <https://github.com/phpDocumentor/guides/issues>`__.
* If you can, please try to fix the problem yourself.

# Make changes (create pull requests)

See the `Contribution chapter <https://github.com/phpDocumentor/guides/tree/main/docs/contributions/index.rst>`__ in the
`Documentation` <https://github.com/phpDocumentor/guides/tree/main/docs/index.rst>`__.
2 changes: 1 addition & 1 deletion packages/guides/.gitattributes
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/.gitattributes export-ignore
/docs export-ignore
/examples export-ignore
/tests export-ignore
/.gitignore export-ignore
.github export-ignore
18 changes: 18 additions & 0 deletions packages/guides/.github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Contribute to the phpDocumentor Guides

## Go to the mono-repository

This project is developed in the mono-repository `phpDocumentor Guides <https://github.com/phpDocumentor/guides>`__.
The repository you are currently in gets auto-created by splitting the mono-repository. You **must not** contribute
to this repository directly but always to the mono-repository linked above.

## Create Issues

* If you find something missing or something is wrong in this library, you are welcome to write an issue
describing the problem: `Issues on GitHub <https://github.com/phpDocumentor/guides/issues>`__.
* If you can, please try to fix the problem yourself.

# Make changes (create pull requests)

See the `Contribution chapter <https://github.com/phpDocumentor/guides/tree/main/docs/contributions/index.rst>`__ in the
`Documentation` <https://github.com/phpDocumentor/guides/tree/main/docs/index.rst>`__.

0 comments on commit 2766064

Please sign in to comment.