Skip to content

Commit 9f256a3

Browse files
committed
Create contributing guidelines
1 parent ad37010 commit 9f256a3

File tree

2 files changed

+81
-10
lines changed

2 files changed

+81
-10
lines changed

CONTRIBUTING.md

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contribute to phpBB Documentation
2+
3+
Do you have an improvement, bug fix or translation for our Docs?
4+
5+
## Contents:
6+
1. [Fork and Clone](#fork-and-clone)
7+
2. [Create a Branch](#create-a-branch)
8+
3. [Submit a Pull Request](#submit-a-pull-request)
9+
4. [Build Development Docs](#build-development-docs)
10+
11+
## Fork and Clone
12+
13+
1. On GitHub, create a fork of `phpbb/documentation` to your GitHub account.
14+
15+
2. Create a local clone of your fork:
16+
```shell
17+
$ git clone git://github.com/YOUR_GITHUB_NAME/documentation.git
18+
```
19+
20+
## Create a Branch
21+
22+
1. Create a new branch in your repository before doing any work. It should be based off the branch you intend to update:
23+
```shell
24+
$ git checkout -b myNewbranch origin/master
25+
```
26+
27+
2. Do work on your branch, commit your changes and push it to your repository:
28+
```shell
29+
$ git commit -a -m "My new feature or bug fixes"
30+
$ git push origin myNewbranch
31+
```
32+
33+
## Submit a Pull Request
34+
35+
1. Go to your repository on GitHub.com.
36+
37+
2. Click the Pull Request button.
38+
39+
3. Make sure the correct branch is selected in the base branch dropdown menu.
40+
41+
## Build Development Docs
42+
43+
You can build our Development Docs in your local environment to make it easier when writing new or updated
44+
documentation. The following steps may vary slightly depending on your OS, so if you run into any trouble you may
45+
ask for guidance in our [Discord or IRC Channels](https://www.phpbb.com/support/chat/).
46+
47+
1. Make sure you have Python3 installed (you can check by running `$ python -V`)
48+
49+
2. Make sure your have PIP installed (you can check by running `$ pip -V`)
50+
51+
3. Install [Sphinx Docs](https://www.sphinx-doc.org/en/master/usage/installation.html):
52+
```shell
53+
$ pip install -U sphinx
54+
```
55+
56+
4. Verify Sphinx installed:
57+
```shell
58+
$ sphinx-build --version
59+
```
60+
> You may need to set a shell $PATH variable to point to wherever your Sphinx binaries were installed in your system
61+
62+
5. Install all the dependencies needed for our Docs:
63+
```shell
64+
$ pip install sphinx_rtd_theme
65+
$ pip install sphinxcontrib-phpdomain
66+
$ pip install sphinx-multiversion
67+
$ sudo pip install git+https://github.com/marc1706/sphinx-php.git
68+
```
69+
70+
6. Build the Docs
71+
```shell
72+
$ cd development
73+
$ make html
74+
```
75+
76+
7. You can now view the Docs by pointing a browser to `development/_build/html/index.html`

readme.md

+5-10
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,14 @@
1-
# phpBB Documentation
1+
# phpBB User Documentation
22

3-
Documentation for board visitors, moderators and administrators. Can be seen online [here](http://www.phpbb.com/support/documentation/3.2/)
3+
Documentation for board visitors, moderators and administrators can be seen online [here](http://www.phpbb.com/support/documentation/3.2/)
44

5-
## Patches
5+
# phpBB Developer Documentation
66

7-
Do you have an improvement? Did you fix a bug? Fork our GitHub repo, make your changes in a separate branch and send a pull request.
8-
Please read the [Git Sub-Project Guidelines](http://wiki.phpbb.com/Sub-Project_Contribution_Guidelines) before forking and fixing bugs.
9-
10-
## Translations
11-
12-
If you have a translation please read the information on patches.
7+
Documentation for phpBB development and extension authors can be seen online [here](https://area51.phpbb.com/docs/dev/)
138

149
## Get Involved
1510

16-
You can get involved by providing patches/improvements (See Above).
11+
Do you have an improvement, bug fix or translation for our Docs? Read our [Contributing guidelines](CONTRIBUTING.md) to help improve our Documentation.
1712

1813
## License
1914
Documentation © 2020 [phpBB Limited](https://www.phpbb.com/)

0 commit comments

Comments
 (0)