Skip to content

Commit 9a510d8

Browse files
cthoytPyKEEN-bot
andauthoredMar 28, 2021
🍠 🎃 Squash warnings and other random cleanup (pykeen#360)
* Squash warnings * Use externalize unittest templates * Fix generics * Trigger CI * Update CONTRIBUTING.md Trigger CI * Update test case name * Update setup.cfg Trigger CI * Fix windows config Trigger CI * Add docs * Reorganize * Update emb.py Trigger CI * Reorganize norm module * Update regularizers.py Trigger CI * Remove norm Trigger CI * Update utils.py Trigger CI Co-authored-by: PyKEEN_bot <[email protected]>
1 parent eeaf1d6 commit 9a510d8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+164
-212
lines changed
 

‎.github/workflows/tests.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ jobs:
104104
run: |
105105
conda install pip setuptools wheel pytest sqlite
106106
conda install pytorch torchvision cudatoolkit=10.2 -c pytorch
107-
pip install -e .[mlflow,wandb]
107+
pip install -e .[mlflow,wandb,tests]
108108
- name: Run fast tests
109109
run: pytest --durations=20 tests -m "not slow"
110110
- name: Run slow tests

‎CONTRIBUTING.md

+25-15
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ the problems the KGE community is currently facing, and has a lot of excited peo
66

77
## Having a Problem? Submit an Issue.
88

9-
1. Check that you have the latest version of :code:`PyKEEN`
9+
1. Check that you have the latest version of `pykeen`
1010
2. Check that StackOverflow hasn't already solved your problem
1111
3. Go here: https://github.com/pykeen/pykeen/issues
1212
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.
2424
https://github.com/pykeen/pykeen
2525
2. Clone your directory with
2626

27+
```shell
2728
$ 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
3031
automatically in your installation.
3132

33+
```shell
3234
$ cd pykeen
3335
$ 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
3438

35-
4. Make a branch off of develop, then make contributions! This line makes a new branch and checks it out
36-
39+
```shell
3740
$ 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.
3844

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
4246
$ tox
43-
47+
```
4448
## Pull Requests
4549

4650
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.
4852
4953
Make a descriptive comment about your pull request, perhaps referencing the issue it is meant to fix (something along
5054
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
5256
to make changes to your pull request, simply push more commits to the feature branch in your fork to GitHub and they
5357
will automatically be added to the pull. You do not need to close and reissue your pull request to make changes!
5458
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
5660
"upstream") before you can make your pull request. In keep your fork up to date with upstream by pulling the
5761
changes--if your fork has diverged too much, it becomes difficult to properly merge pull requests without conflicts.
5862
5963
To pull in upstream changes::
6064
65+
```shell
6166
$ git remote add upstream https://github.com/pykeen
62-
$ git fetch upstream develop
67+
$ git fetch upstream maser
68+
```
6369
6470
Check the log to make sure the upstream changes don't affect your work too much::
6571

66-
$ git log upstream/develop
72+
```shell
73+
$ git log upstream/master
74+
```
6775

6876
Then merge in the new changes::
6977

70-
$ git merge upstream/develop
78+
```shell
79+
$ git merge upstream/master
80+
```
7181

7282
More information about this whole fork-pull-merge process can be found `here on Github's
7383
website <https://help.github.com/articles/fork-a-repo/>`_.

0 commit comments

Comments
 (0)
Please sign in to comment.