Browse Source

Initial add of template docs and contribution guide

pull/258/head
parent
commit
5653996062
Signed by: Hristos N. Triantafillou <me@hristos.triantafillou.us> GPG Key ID: 5FC7664AD47AA1C5
3 changed files with 108 additions and 0 deletions
  1. 75
    0
      CONTRIBUTING.md
  2. 19
    0
      ISSUE_TEMPLATE.md
  3. 14
    0
      PULL_REQUEST_TEMPLATE.md

+ 75
- 0
CONTRIBUTING.md View File

@@ -0,0 +1,75 @@
1
+# Contributing Guide
2
+
3
+This document shows you how to get the project and run various local dev tasks.
4
+
5
+## Dependencies
6
+
7
+To make sure that the following instructions work, please install the following dependencies
8
+on your machine:
9
+
10
+- Git
11
+- Python3 (the latest 3.X release is desireable)
12
+- python3-pip
13
+
14
+## Installation
15
+
16
+To get the source, clone the git repository via:
17
+
18
+````
19
+$ git clone http://git.modding-openmw.com/Modding-OpenMW.com/momw.git
20
+````
21
+
22
+This will clone the complete source to your local machine. Navigate to the project folder
23
+and install all needed dependencies via **pip3**:
24
+
25
+````
26
+$ pip3 install --user --upgrade -r requirements.txt
27
+````
28
+
29
+If desired, the `--user` flag may be omitted but this is not advised.
30
+
31
+## Testing
32
+
33
+Tests depend on a working install of both the chrome and gecko webdrivers for selenium.
34
+Their installation and setup is (for now) outside the scope of this document, but all
35
+that's necessary is to have `chromedriver` and `geckodriver` binaries for your OS in
36
+your `$PATH`.
37
+
38
+To run tests:
39
+
40
+    make test
41
+
42
+After a short time, a chrome or chromium instance will pop up with a note about it being
43
+controlled by software.  After a bit more time it will close and then firefox will open
44
+and do the same.  This is normal and part of the test suite.
45
+
46
+### Source linting
47
+
48
+Source linting happens as part of the `make test` target.
49
+
50
+### Buildbot
51
+
52
+Any commit to any branch on the primary `Modding-OpenMW.com/momw` repository will kick off
53
+[a buildbot build](https://buildbot.modding-openmw.com/).
54
+
55
+## Contributing/Submitting changes
56
+
57
+* Check out a new branch based on `dev` and name it to what you intend to do:
58
+  * Example:
59
+    ````
60
+    $ git checkout -b my-cool-feature origin/dev
61
+    ````
62
+    If you get an error, you may need to fetch dev first by using
63
+    ````
64
+    $ git remote update && git fetch
65
+    ````
66
+  * Use one branch per fix/feature
67
+* Make your changes
68
+  * Run your tests with `make test`.
69
+  * When all tests pass, everything's fine.
70
+* Commit your changes
71
+  * Please provide a git message that explains what you've done.
72
+  * Commit to a forked repository on our Gitea instance.
73
+* Make a pull request
74
+  * Make sure you send the PR to the `dev` branch.
75
+  * A passing Buildbot build is required before any changes are merged.

+ 19
- 0
ISSUE_TEMPLATE.md View File

@@ -0,0 +1,19 @@
1
+### Subject of the issue
2
+Describe your issue here.
3
+
4
+### Your environment
5
+* What is the affected mod name and version (if applicable)?
6
+* What is your OpenMW version?
7
+
8
+### Website Issues
9
+* If the issue is related to the website -- what web browser are you using, and what version?
10
+* What is your OS?
11
+
12
+### Steps to reproduce
13
+Tell us how to reproduce this issue. Please provide a detailed list of steps.
14
+
15
+### Expected behaviour
16
+Tell us what should happen
17
+
18
+### Actual behaviour
19
+Tell us what happens instead

+ 14
- 0
PULL_REQUEST_TEMPLATE.md View File

@@ -0,0 +1,14 @@
1
+### Your checklist for this pull request
2
+
3
+Please review the [guidelines for contributing](CONTRIBUTING.md) to this repository.
4
+
5
+* [ ] Make sure you are requesting to **pull a topic/feature/bugfix branch** (right side). Don't request your master!
6
+* [ ] Make sure you are making a pull request against the **dev branch** (left side). Also you should start *your branch* off *our dev*.
7
+* [ ] Check the commit's or even all commits' message styles matches our requested structure.
8
+* [ ] Check your code additions will fail neither code linting checks nor unit test.
9
+* [ ] If you've added a page, function, or any other content, there is sufficient test coverage.
10
+
11
+### Description
12
+Please describe your pull request.
13
+
14
+Thank you!

Loading…
Cancel
Save