Skip to content

Commit 5f3890b

Browse files
htahir1htahir1
committed
merged main
2 parents 4ad13d2 + a4717de commit 5f3890b

File tree

14 files changed

+688
-13
lines changed

14 files changed

+688
-13
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: General
3+
labels: general
4+
about: I have a general issue I would like to write about
5+
---
6+
7+
## Checks
8+
9+
* [ ] I added a descriptive title to this issue
10+
* [ ] I have searched (google, github) for similar issues and couldn't find anything
11+
* [ ] I have read and followed [the docs](https://docs.zenml.io/) and still think this is a bug
12+
13+
<!-- Sorry this is a pain to fill out, but it really helps maintainers make ZenML better! -->
14+
15+
## General
16+

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Feature Request
4+
url: https://zenml.io/discussion
5+
about: Request a new feature.
6+
- name: Slack Channel
7+
url: https://zenml.io/slack-invite/
8+
about: Chat with us directly here.
9+
- name: Docs
10+
url: https://docs.zenml.io/
11+
about: Read the docs to answer most commonly asked questions.

‎.github/workflows/release.yml‎

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ on:
44
workflow_dispatch:
55
push:
66
tags:
7-
- "*"
7+
- "v*"
88

99
jobs:
1010
release:
@@ -13,9 +13,8 @@ jobs:
1313
steps:
1414
- name: Checkout Repository
1515
uses: actions/checkout@v2
16-
- name: Get the version from the github tag ref
17-
id: get_version
18-
run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\//}
16+
with:
17+
fetch-depth: 0
1918
- uses: actions/setup-node@v3
2019
with:
2120
node-version: 14.20.0
@@ -28,7 +27,11 @@ jobs:
2827
env:
2928
REACT_APP_BASE_API_URL: "/api/v1"
3029
REACT_APP_MOCKAPI_RESPONSE: false
31-
REACT_APP_VERSION: ${{ steps.get_version.outputs.VERSION }}
30+
31+
- name: Get the version from the github tag ref
32+
id: get_version
33+
run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\//}
34+
3235
- name: Generate Changelog
3336
uses: heinrichreimer/[email protected]
3437
with:
@@ -39,15 +42,17 @@ jobs:
3942
issuesWoLabels: "true"
4043
stripHeaders: "true"
4144
- name: Create release archive
42-
run: |
43-
tar -zcf zenml-dashboard.tar.gz -C build --transform="s#\.\/##" .
44-
sha256sum -b zenml-dashboard.tar.gz > zenml-dashboard.tar.gz.sha256
45+
uses: a7ul/[email protected]
46+
id: compress
47+
with:
48+
command: c
49+
files: |
50+
./build
51+
outPath: zenml-dashboard.tar.gz
4552
- name: Release to GitHub
4653
uses: softprops/action-gh-release@v1
4754
with:
48-
files: |
49-
zenml-dashboard.tar.gz
50-
zenml-dashboard.tar.gz.sha256
55+
files: zenml-dashboard.tar.gz
5156
body_path: ./CHANGELOG.md
5257
prerelease: "true"
5358
env:

‎CODE-OF-CONDUCT.md‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[[email protected]](mailto:[email protected]).
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
126+
at [https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/inclusion
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations

‎CONTRIBUTING.md‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
# 🧑‍💻 Contributing to ZenML
2+
3+
A big welcome and thank you for considering contributing to ZenML! It’s people
4+
like you that make it a reality for users
5+
in our community.
6+
7+
Reading and following these guidelines will help us make the contribution
8+
process easy and effective for everyone
9+
involved. It also communicates that you agree to respect the developers' time
10+
management and develop these open-source projects. In return, we will reciprocate that respect by reading your
11+
issue, assessing changes, and helping
12+
you finalize your pull requests.
13+
14+
## ⚡️ Quicklinks
15+
16+
* [Code of Conduct](#code-of-conduct)
17+
* [Getting Started](#getting-started)
18+
* [Issues](#issues)
19+
* [Pull Requests](#pull-requests)
20+
* [Getting Help](#getting-help)
21+
22+
## 🧑‍⚖️ Code of Conduct
23+
24+
We take our open-source community seriously and hold ourselves and other
25+
contributors to high standards of communication.
26+
By participating and contributing to this project, you agree to uphold
27+
our [Code of Conduct](https://github.com/zenml-io/zenml-dashboard/blob/master/CODE-OF-CONDUCT.md).
28+
29+
## 🛫 Getting Started
30+
31+
Contributions are made to this repo via Issues and Pull Requests (PRs). A few
32+
general guidelines that cover both:
33+
34+
- To report security vulnerabilities, please get in touch
35+
at [[email protected]](mailto:[email protected]), monitored by
36+
our security team.
37+
- Search for existing Issues and PRs before creating your own.
38+
- Search on the [public Crowd Dev](https://open.crowd.dev/zenml) page to see
39+
if the issue has been addressed before.
40+
- We work hard to make sure issues are handled on time, but it could take a
41+
while to investigate the root cause depending on the impact.
42+
43+
A friendly ping in the comment thread to the submitter or a contributor can help
44+
draw attention if your issue is blocking.
45+
46+
The best way to start is to check the
47+
[`good-first-issue`](https://github.com/zenml-io/zenml-dashboard/labels/good%20first%20issue)
48+
label on the issue board. The core team creates these issues as necessary
49+
smaller tasks that you can work on to get deeper into ZenML dashboard internals. These
50+
should generally require relatively simple changes, probably affecting just one
51+
or two files which we think are ideal for people new to ZenML dashboard.
52+
53+
The next step after that would be to look at the
54+
[`good-second-issue`](https://github.com/zenml-io/zenml-dashboard/labels/good%20second%20issue)
55+
label on the issue board. These are a bit more complex, might involve more
56+
files, but should still be well-defined and achievable to people relatively new
57+
to ZenML dashboard.
58+
59+
### ⁉️ Issues
60+
61+
Issues should be used to report problems with the library, request a new
62+
feature, or to discuss potential changes before
63+
a PR is created. When you create a new Issue, a template will be loaded that
64+
will guide you through collecting and
65+
providing the information we need to investigate.
66+
67+
If you find an Issue that addresses your problem, please add your own
68+
reproduction information to the
69+
existing issue rather than creating a new one. Adding
70+
a [reaction](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/)
71+
can also help by
72+
indicating to our maintainers that a particular issue is affecting more than
73+
just the reporter.
74+
75+
### 🏷 Pull Requests
76+
77+
Pull Requests (PRs) to ZenML are always welcome and can be a quick way to get your fix or
78+
improvement slated for the next release. In
79+
general, PRs should:
80+
81+
- Only fix/add the functionality in question **OR** address widespread
82+
whitespace/style issues, not both.
83+
- Add unit or integration tests for fixed or changed functionality (if a test
84+
suite already exists).
85+
- Address a single concern in the least number of changed lines as possible.
86+
- Include documentation in the repo or in your Pull Request.
87+
- Be accompanied by a filled-out Pull Request template (loaded automatically when
88+
a PR is created).
89+
90+
For changes that address core functionality or would require breaking changes (e.g. a major release), it's best to open
91+
an Issue to discuss your proposal first. This is not required but can save time
92+
creating and reviewing changes.
93+
94+
<p class="callout warning">Please note that development in ZenML happens off of the <b>develop</b> branch, <b>not main</b>,
95+
which is the default branch on GitHub. Therefore, please pay particular attention to step 5 and step 9 below. </p>
96+
97+
In general, we follow
98+
the ["fork-and-pull" Git workflow](https://github.com/susam/gitpr)
99+
100+
1. Review and sign
101+
the [Contributor License Agreement](https://cla-assistant.io/zenml-io/zenml-dashboard) (
102+
CLA).
103+
2. Fork the repository to your own Github account.
104+
3. Clone the project to your machine.
105+
4. Checkout the **develop** branch <- `git checkout develop`.
106+
5. Create a branch (again, off of the develop branch) locally with a succinct but descriptive name.
107+
6. Commit changes to the branch
108+
7. Push changes to your fork.
109+
8. Open a PR in our repository (to the `develop` branch, **NOT** `main`) and
110+
follow the PR template so that we can efficiently review the changes.
111+
112+
### 🚨 Reporting a Vulnerability
113+
114+
If you think you have found a vulnerability, and even if you are not sure about it,
115+
please report it right away by sending an
116+
email to: [email protected]. Please try to be as explicit as possible,
117+
describing all the steps and example code to
118+
reproduce the security issue.
119+
120+
We will review it thoroughly and get back to you.
121+
122+
Please refrain from publicly discussing a potential security vulnerability as
123+
this could potentially put our users at
124+
risk! It's better to discuss privately and give us a chance to find a solution
125+
first, to limit the potential impact
126+
as much as possible.
127+
128+
129+
## 🆘 Getting Help
130+
131+
Join us in the [ZenML Slack Community](https://zenml.io/slack-invite/) to
132+
interact directly with the core team and community at large. This is a good
133+
place to ideate, discuss concepts or ask for help.

0 commit comments

Comments
 (0)