@@ -6,7 +6,7 @@ the problems the KGE community is currently facing, and has a lot of excited peo
6
6
7
7
## Having a Problem? Submit an Issue.
8
8
9
- 1 . Check that you have the latest version of :code: ` PyKEEN `
9
+ 1 . Check that you have the latest version of ` pykeen `
10
10
2 . Check that StackOverflow hasn't already solved your problem
11
11
3 . Go here: https://github.com/pykeen/pykeen/issues
12
12
4 . Check that this issue hasn't been solved
@@ -24,50 +24,60 @@ Same drill! Submit an issue and we'll have a nice conversation in the thread.
24
24
https://github.com/pykeen/pykeen
25
25
2 . Clone your directory with
26
26
27
+ ``` shell
27
28
$ git clone https://github.com/< YourUsername> /pykeen
28
-
29
- 3 . Install with :code: ` pip ` . The flag, :code: ` -e ` , makes your installation editable, so your changes will be reflected
29
+ ```
30
+ 3. Install with ` pip` . The flag, ` -e` , makes your installation editable, so your changes will be reflected
30
31
automatically in your installation.
31
32
33
+ ` ` ` shell
32
34
$ cd pykeen
33
35
$ python3 -m pip install -e .
36
+ ` ` `
37
+ 4. Make a branch off of the master branch, then make contributions! This line makes a new branch and checks it out
34
38
35
- 4 . Make a branch off of develop, then make contributions! This line makes a new branch and checks it out
36
-
39
+ ` ` ` shell
37
40
$ git checkout -b feature/< YourFeatureName>
41
+ ` ` `
42
+ 5. This project should be well tested, so write unit tests in the ` tests/` directory
43
+ 6. Check that all tests are passing and code coverage is good with ` tox` before committing.
38
44
39
- 5 . This project should be well tested, so write unit tests in the :code:` tests/ ` directory
40
- 6 . Check that all tests are passing and code coverage is good with :code:` tox ` before committing.
41
-
45
+ ` ` ` shell
42
46
$ tox
43
-
47
+ ` ` `
44
48
# # Pull Requests
45
49
46
50
Once you' ve got your feature or bugfix finished (or if its in a partially complete state but you want to publish it
47
- for comment), push it to your fork of the repository and open a pull request against the develop branch on GitHub.
51
+ for comment), push it to your fork of the repository and open a pull request against the master branch on GitHub.
48
52
49
53
Make a descriptive comment about your pull request, perhaps referencing the issue it is meant to fix (something along
50
54
the lines of "fixes issue #10" will cause GitHub to automatically link to that issue). The maintainers will review your
51
- pull request and perhaps make comments about it, request changes, or may pull it in to the develop branch! If you need
55
+ pull request and perhaps make comments about it, request changes, or may pull it in to the master branch! If you need
52
56
to make changes to your pull request, simply push more commits to the feature branch in your fork to GitHub and they
53
57
will automatically be added to the pull. You do not need to close and reissue your pull request to make changes!
54
58
55
- If you spend a while working on your changes, further commits may be made to the main :code: ` PyKEEN ` repository (called
59
+ If you spend a while working on your changes, further commits may be made to the main `pykeen ` repository (called
56
60
"upstream") before you can make your pull request. In keep your fork up to date with upstream by pulling the
57
61
changes--if your fork has diverged too much, it becomes difficult to properly merge pull requests without conflicts.
58
62
59
63
To pull in upstream changes::
60
64
65
+ ```shell
61
66
$ git remote add upstream https://github.com/pykeen
62
- $ git fetch upstream develop
67
+ $ git fetch upstream maser
68
+ ```
63
69
64
70
Check the log to make sure the upstream changes don' t affect your work too much::
65
71
66
- $ git log upstream/develop
72
+ ` ` ` shell
73
+ $ git log upstream/master
74
+ ` ` `
67
75
68
76
Then merge in the new changes::
69
77
70
- $ git merge upstream/develop
78
+ ` ` ` shell
79
+ $ git merge upstream/master
80
+ ` ` `
71
81
72
82
More information about this whole fork-pull-merge process can be found ` here on Github' s
73
83
website <https://help.github.com/articles/fork-a-repo/>`_.
0 commit comments