Skip to content

Commit 26a2f4d

Browse files
robwittmanrobwittman
authored
[DEVOPS-1590] Supporting Project files (#9)
* Add initial docs (stash) * Add pull request template and LICENSE * Add headers to README * Use BSD-3 license, add badge * Disable kernel builds
1 parent 270355d commit 26a2f4d

File tree

6 files changed

+220
-27
lines changed

6 files changed

+220
-27
lines changed

‎.github/pull_request_template.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## Describe your changes
2+
3+
## Issue ticket number and link
4+
5+
## Checklist before requesting a review
6+
- [ ] I have performed a self-review of my code
7+
- [ ] I am able to build images locally
8+
- [ ] Has the issue it resolves been discussed with maintainers?

‎.github/workflows/build.yml

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -29,29 +29,29 @@ jobs:
2929
VALIDATE_DOCKERFILE_HADOLINT: true
3030
VALIDATE_YAML: true
3131

32-
build_python_kernel:
33-
permissions:
34-
id-token: write
35-
contents: read
36-
packages: write
37-
actions: write
38-
uses: ./.github/workflows/reusable-docker-build.yml
39-
strategy:
40-
matrix:
41-
# Must be a supported version by jupyter/datascience-notebook
42-
# https://hub.docker.com/r/jupyter/datascience-notebook/tags?page=1&name=python-
43-
version: [ "3.9.13", "3.8.13" ]
44-
secrets: inherit
45-
with:
46-
dockerfile: ./kernels/python/Dockerfile
47-
context: ./kernels/python
48-
images: |
49-
ghcr.io/${{ github.repository }}/python
50-
tags: |
51-
type=ref,event=branch,prefix=${{ matrix.version }}
52-
type=ref,event=pr,prefix=${{ matrix.version }}
53-
type=sha,format=long,prefix=${{ matrix.version }}
54-
type=raw,value=latest,enable=${{ github.ref == format('refs/heads/{0}', 'main') }},prefix=${{ matrix.version }}
55-
build_args: |
56-
PYTHON_VERSION=${{ matrix.version }}
57-
platforms: "linux/amd64"
32+
# build_python_kernel:
33+
# permissions:
34+
# id-token: write
35+
# contents: read
36+
# packages: write
37+
# actions: write
38+
# uses: ./.github/workflows/reusable-docker-build.yml
39+
# strategy:
40+
# matrix:
41+
# # Must be a supported version by jupyter/datascience-notebook
42+
# # https://hub.docker.com/r/jupyter/datascience-notebook/tags?page=1&name=python-
43+
# version: [ "3.9.13", "3.8.13" ]
44+
# secrets: inherit
45+
# with:
46+
# dockerfile: ./kernels/python/Dockerfile
47+
# context: ./kernels/python
48+
# images: |
49+
# ghcr.io/${{ github.repository }}/python
50+
# tags: |
51+
# type=ref,event=branch,prefix=${{ matrix.version }}
52+
# type=ref,event=pr,prefix=${{ matrix.version }}
53+
# type=sha,format=long,prefix=${{ matrix.version }}
54+
# type=raw,value=latest,enable=${{ github.ref == format('refs/heads/{0}', 'main') }},prefix=${{ matrix.version }}
55+
# build_args: |
56+
# PYTHON_VERSION=${{ matrix.version }}
57+
# platforms: "linux/amd64"

‎CODE_OF_CONDUCT.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Code of Conduct
2+
3+
### Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
### Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
### Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
### Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
### Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
### Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at [http://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: http://contributor-covenant.org
74+
[version]: http://contributor-covenant.org/version/1/4/

‎CONTRIBUTING.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Contributing Guide
2+
3+
* [New Contributor Guide](#contributing-guide)
4+
* [Ways to Contribute](#ways-to-contribute)
5+
* [Ask for Help](#ask-for-help)
6+
* [Development Environment Setup](#development-environment-setup)
7+
* [Sign Your Commits](#sign-your-commits)
8+
* [Pull Request Checklist](#pull-request-checklist)
9+
10+
Welcome! We are glad that you want to contribute to our kernels
11+
12+
As you get started, you are in the best position to give us feedback on areas of
13+
our project that we need help with including:
14+
15+
* Problems found during setting up a new developer environment
16+
* Gaps in our Getting started Guide or documentation
17+
* Bugs in our automation scripts
18+
19+
If anything doesn't make sense, or doesn't work when you run it, please open a
20+
bug report and let us know!
21+
22+
## Ways to Contribute
23+
24+
We welcome many different types of contributions including:
25+
26+
* New features
27+
* Builds, CI/CD
28+
* Bug fixes
29+
* Documentation
30+
31+
## Pull Request Lifecycle
32+
33+
## Development Environment Setup
34+
35+
To begin contributing changes to notebook kernels, you'll need to setup your local environment
36+
37+
### Requirements
38+
- `python`: Version depending on which kernels being built
39+
- `docker`: For building and testing images
40+
41+
### Setup
42+
```shell
43+
git clone [email protected]:noteable-io/kernels
44+
cd kernels/$kernel/
45+
# Make proposed edits as needed
46+
docker buildx bake <target>
47+
```
48+
49+
## Sign Your Commits
50+
51+
All commits to this repository must be signed by the author. Please review https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits
52+
for information on configuring your machine to do so.
53+
54+
## Pull Request Checklist
55+
56+
When you submit your pull request, or you push new commits to it, our automated
57+
systems will run some checks on your new code. We require that your pull request
58+
passes these checks, but we also have more criteria than just that before we can
59+
accept and merge it. We recommend that you check the following things locally
60+
before you submit your code:
61+
62+
- [ ] I have performed a self-review of my code
63+
- [ ] I am able to build images locally
64+
- [ ] Has the issue it resolves been discussed with maintainers?
65+
66+
**Note**: This checklist is also part of the pull request template for this project

‎LICENSE

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
BSD 3-Clause License
2+
3+
Copyright (c) 2023, Noteable
4+
All rights reserved
5+
6+
Redistribution and use in source and binary forms, with or without
7+
modification, are permitted provided that the following conditions are met:
8+
9+
* Redistributions of source code must retain the above copyright notice, this
10+
list of conditions and the following disclaimer.
11+
12+
* Redistributions in binary form must reproduce the above copyright notice,
13+
this list of conditions and the following disclaimer in the documentation
14+
and/or other materials provided with the distribution.
15+
16+
* Neither the name of the copyright holder nor the names of its
17+
contributors may be used to endorse or promote products derived from
18+
this software without specific prior written permission.
19+
20+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
24+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
26+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

‎README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,17 @@
1-
# kernels
1+
# Noteable Kernels
2+
3+
[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
4+
5+
This project contains the configuration and build pipelines for kernels on the Noteable platform.
6+
7+
## Documentation
8+
TBD
9+
10+
## Community
11+
TBD
12+
13+
## Contributing
14+
Contributions are welcomed and appreciated! See [Contributing](CONTRIBUTING.md) for our guidelines
15+
16+
### Getting Started
17+
TBD

0 commit comments

Comments
 (0)