Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

53 add contributing guidelines and improve triage #54

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
a69651e
Create CONTRIBUTING.md
epignatelli Feb 2, 2023
b5f0a54
Update CONTRIBUTING.md
epignatelli Feb 2, 2023
b08fae8
Update CONTRIBUTING.md
epignatelli Feb 2, 2023
fe3b9a3
Update CONTRIBUTING.md
epignatelli Feb 2, 2023
d342be2
Update CONTRIBUTING.md
epignatelli Feb 2, 2023
6455cf2
Update CONTRIBUTING.md
epignatelli Feb 2, 2023
472c672
fix(issue_template): broken links
epignatelli Feb 3, 2023
efda0cf
fix(issue_template): wrong label assigned to "feature"
epignatelli Feb 3, 2023
bc1f42d
misc(issue_template): add templates for all commit types
epignatelli Feb 4, 2023
7ca9007
ci(triage): get column for each issue type
epignatelli Feb 4, 2023
a8c79ce
chores(issue_template): add performance issue template
epignatelli Feb 4, 2023
bff85f1
ci(triage): assign issue to a specific project column
epignatelli Feb 4, 2023
ad402e7
ci(triage): correct priority and no typo
epignatelli Feb 4, 2023
16a5ec9
skip if pr
epignatelli Feb 4, 2023
28296d9
remove quotes in bash script
epignatelli Feb 4, 2023
6d0e2ad
temporary test wofklow on push
epignatelli Feb 4, 2023
ba98d1d
these actions are buggy -- we cannot trust them
epignatelli Feb 4, 2023
d1c74e7
style(all): black all
epignatelli Feb 4, 2023
9670506
style(issue_template): new line aof
epignatelli Feb 4, 2023
3587efa
docs(contributing): add contributing guidelines
epignatelli Feb 4, 2023
ef9f078
docs(contributing): finalise contributing
epignatelli Mar 3, 2023
d233f30
docs(readme): punchier pitch for helx
epignatelli Mar 3, 2023
c953f63
docs(readme): Add the how
epignatelli Mar 3, 2023
ef60271
docs(readme): Add the how
epignatelli Mar 3, 2023
0379be1
docs(readme): algorithms are backend agnostic
epignatelli Mar 3, 2023
28f29b3
docs(readme): add examples of agents and environments
epignatelli Mar 3, 2023
480963e
docs(readme): cleanup readme
epignatelli Mar 3, 2023
538e3ee
docs(readme): remove prerequisites
epignatelli Mar 3, 2023
d150bad
build(extras): add a way to set mujoco path from code
epignatelli Mar 3, 2023
1915dec
docs(readme): add developer install instructions
epignatelli Mar 3, 2023
8000b9b
docs(readme): promote "why helx" to h2
epignatelli Mar 3, 2023
e4ede80
build(requirements): reinstate mujoco-py in requirements
epignatelli Mar 4, 2023
a6f470e
docs(readme): badges target only main branch
epignatelli Mar 4, 2023
ca5d346
revert(build): remove mujoco-py from requirements
epignatelli Mar 4, 2023
288793f
build(scripts): add script to configure mujoco vars
epignatelli Mar 4, 2023
b8002d6
build(mujoco): try fix mujoco clean run
epignatelli Mar 4, 2023
a77b567
fix(scripts): fix scripts entry point:
epignatelli Mar 4, 2023
2b8f105
build(scripts): move scripts into package
epignatelli Mar 4, 2023
2e6603a
fix(scripts): relative import failing
epignatelli Mar 4, 2023
1f1e38f
revert(ci): revert remove conda vars setup
epignatelli Mar 5, 2023
befd167
build(requirements): add mujoco to requirements as requested by the e…
epignatelli Mar 5, 2023
09aba17
build(ci): downgrade mujoco to 2.1.1
epignatelli Mar 5, 2023
ca172c1
build(ci): install mujoco before gym
epignatelli Mar 5, 2023
4e1c74a
remove timeout and stop on new commit
epignatelli Mar 5, 2023
321191e
fix(ci): typo
epignatelli Mar 5, 2023
0e84422
add GLew LD_PRELOAD
epignatelli Mar 5, 2023
009493b
mujoco renders osmesa
epignatelli Mar 5, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ body:
## A bug found is a bug fixed, thank you for helping with Helx!

* Please first verify that your issue is not already reported using the
[issue search][https://github.com/epignatelli/helx/search?q=is%3Aissue&type=issues].
[issue search](https://github.com/epignatelli/helx/search?q=is%3Aissue&type=issues).

* If you would like a new feature, please consider
[requesting one](https://github.com/epignatelli/helx/issues/new?template=feature.yml)

* If you would like to ask a question, please consider
[opening a discussion](https://github.com/epignatelli/helx/discussions)

* If you prefer a non-templated issue report, click [here][http://github.com/epignatelli/helx/issues/new].
* If you prefer a non-templated issue report, click [here](http://github.com/epignatelli/helx/issues/new).

- type: textarea
attributes:
Expand Down
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: Installation or build issue
description: >-
A problem with the installation or build process.
labels:
- installation/build

body:
- type: textarea
attributes:
label: Description
description: >-
A concise description of what of what you would like to add or change.
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: Continuous Integration (CI) and Continuous Deployment (CD)
description: >-
Add or change CI/CD workflows.
labels:
- ci

body:
- type: textarea
attributes:
label: Description
description: >-
A concise description of what of what you would like to add or change.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ blank_issues_enabled: false
contact_links:
- name: Have questions or want to have a chat?
url: https://github.com/epignatelli/helx/discussions
about: Please ask questions on the Discussions tab
about: Please ask questions on the Discussions tab
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: Documentation
description: >-
Add or edit documentation.
labels:
- documentation

body:
- type: textarea
attributes:
label: Description
description: >-
A concise description of what of what you would like to add or change.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Feature or improvement request
description: >-
Request a missing feature, or an improvement to an existing feature that is not a bug
labels:
- bug
- feature

body:
- type: markdown
Expand Down
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/performance.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: Performance
description: >-
A code change that improves performance but does not change the functionality or the API.
labels:
- performance

body:
- type: textarea
attributes:
label: Description
description: >-
A concise description of what of what you would like to add or change.
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/refactor.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: Refactor
description: >-
A code change that restructures the existing code, like namespace changes.
labels:
- refactor

body:
- type: textarea
attributes:
label: Description
description: >-
A concise description of what of what you would like to add or change.
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/revert.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: Revert a previous change
description: >-
Revert a change made in a previous commit.
labels:
- revert

body:
- type: textarea
attributes:
label: Description
description: >-
A concise description of what of what you would like to add or change.
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/style.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: Style
description: >-
Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons)
labels:
- style

body:
- type: textarea
attributes:
label: Description
description: >-
A concise description of what of what you would like to add or change.
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: Unittests and examples
description: >-
Add or edit unittests or examples.
labels:
- test

body:
- type: textarea
attributes:
label: Description
description: >-
A concise description of what of what you would like to add or change.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ and any information that can improve and speed-up the review process.
For example:
- Add a way to do X
- Fix a bug with Y
-->
-->
9 changes: 8 additions & 1 deletion .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,14 @@ on:
pull_request:
types: [opened, synchronize, reopened]

concurrency:
group: ${{ github.head_ref }}
cancel-in-progress: true

jobs:
Test:
runs-on: ${{ matrix.os }}-latest
timeout-minutes: 30
defaults:
run:
shell: bash -l {0}
Expand All @@ -28,10 +33,11 @@ jobs:
run: |
pip install . -v
helx-download-extras
conda env config vars set MUJOCO_GL=osmesa PYOPENGL_PLATFORM=osmesa
conda env config vars set LD_PRELOAD=$CONDA_PREFIX/x86_64-conda-linux-gnu/sysroot/usr/lib64/libGLdispatch.so.0:/usr/lib/x86_64-linux-gnu/libGLEW.so
conda env config vars set LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$HOME/.mujoco/mujoco210/bin
conda env config vars set MJLIB_PATH=$HOME/.mujoco/mujoco210/bin/libmujoco210.so
conda env config vars set MUJOCO_PY_MUJOCO_PATH=$HOME/.mujoco/mujoco210
conda env config vars set LD_PRELOAD=$CONDA_PREFIX/x86_64-conda-linux-gnu/sysroot/usr/lib64/libGLdispatch.so.0
- name: Check code quality
run: |
pip install pylint
Expand All @@ -48,6 +54,7 @@ jobs:

Compliance:
runs-on: ubuntu-latest
timeout-minutes: 30
steps:
- uses: actions/checkout@v3
with:
Expand Down
78 changes: 78 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# Contributing to helx
If you are reading this, your are interested in contributing -- and time is precious, so thank you very much for your time.
This guidelines are designed to guide you through how to submit commits to `helx`.


## Code of conduct
First and foremost, please be respectuful to others.
Please, read and follow our [Code of conduct](https://github.com/epignatelli/helx/CODE_OF_CONDUCT.md).
The code applies to both humans and bots.


## Committing code
Contributing to the codebase or to other any operational support material happens through Pull Requests (PRs).
If you have already a PR in mind, please open an issue first, explaining the underlying motivation for the change.
To commit new code, please:
1. Open a [new issue](https://github.com/epignatelli/helx/issues/new/choose) and assign yourself to it
2. Create and work on a new branch -- you can do it [directly from the issue page](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-a-branch-for-an-issue)
3. When you are ready to merge, or you you have a proof of concept to discuss, open a PR, assign yourself to it, and ask review from one of the team



## Development install
You can install `helx` in your development environment using `conda` and `pip`.
From the repository root, you can install the package in development mode (`-e`) in a pre-baked environment:
```bash
git clone https://github.com/epignatelli/helx
cd helx
conda env create -f environment.yml
pip install -e .
```

## Testing
We use `pytest` for testing.
You can run the tests with:
```bash
pytest test/
```

---
## Standards
### Python code
We adopt the [PEP8 Python style guide](https://peps.python.org/pep-0008/), and a big handful of good old common sense.
Please, keep your code as modular as possible.

### Documentation
We adopt the [Goole Python docstrings style guide](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings).

### Versioning
We adopt the [semantic versioning](https://semver.org/) standard.
No prefixes, no suffixes are allowed, and no alpha/beta/rc versions are allowed.
The version number is automatically calculated by the CD, based on the commit messages (see [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/#how-does-this-relate-to-semver) for more, and read further for more details).

### Commit messages
We adopt the [angular convention](https://github.com/angular/angular/blob/68a6a07/CONTRIBUTING.md#commit) for commit messages.
The commit message consists of a header, a body, and a footer:
```
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
```
The type is one of the following:
* **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
* **ci**: Changes to our CI configuration files and scripts (examples: CircleCi, SauceLabs)
* **docs**: Documentation only changes
* **feat**: A new feature
* **fix**: A bug fix
* **perf**: A code change that improves performance
* **refactor**: A code change that neither fixes a bug nor adds a feature
* **test**: Adding missing tests or correcting existing tests

The scope is the name of the package affected (as perceived by the person reading the changelog generated from commit messages).

### Branch names and PR titles
It is recommended to create a new branch [directly from the issue page](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-a-branch-for-an-issue) on GitHub.
In this case, branch names and PR titles are generated automatically.
If you are targeting multiple issues, please include all issue numbers in the PR title, separated by a comma.
Loading