Skip to content

Commit 8e0c3c7

Browse files
daavoodaavoo
authored
Initial implementation of features for 1st version (#2)
* Update README * Add CODE_OF_CONDUCT * Add placeholder CONTRIBUTING.md * Add Issue and Pull Request template * Add and run pre-commit * Add docs setup * Add lint workflow * Add devcontainer.json * Add demo/app.py * pre-commit run
1 parent df23c78 commit 8e0c3c7

16 files changed

+289
-1
lines changed

Diff for: ‎.github/.devcontainer.json

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"name": "Python Development Container",
3+
"image": "mcr.microsoft.com/devcontainers/base:ubuntu",
4+
"features": {
5+
"ghcr.io/devcontainers/features/python": {
6+
"version": "latest"
7+
}
8+
},
9+
"postCreateCommand": "pip install -r requirements.txt"
10+
}

Diff for: ‎.github/ISSUE_TEMPLATE/bug_report.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**System Information (please complete the following information):**
14+
- OS: [e.g. macOS Sonoma]
15+
- Lumigator version [e.g. commit SHA]
16+
17+
**To Reproduce**
18+
Steps to reproduce the behavior:
19+
1. Go to '...'
20+
2. Click on '...'
21+
3. Scroll down to '...'
22+
4. See error
23+
24+
**Expected behavior**
25+
If applicable, a clear and concise description of what you expected to happen.
26+
27+
**Screenshots**
28+
If applicable, add screenshots to help explain your problem.
29+
30+
**Additional context**
31+
Add any other context about the problem here.

Diff for: ‎.github/ISSUE_TEMPLATE/feature_request.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

Diff for: ‎.github/pull_request_template.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## What's changing
2+
3+
## How to test it
4+
5+
## Additional notes for reviewers

Diff for: ‎.github/workflows/docs.yaml

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Documentation
2+
3+
on:
4+
push:
5+
branches: [main]
6+
workflow_dispatch:
7+
8+
jobs:
9+
docs:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Check out the repository
13+
uses: actions/checkout@v4
14+
with:
15+
fetch-depth: 0
16+
17+
- name: Set up Python
18+
uses: actions/setup-python@v5
19+
with:
20+
python-version: '3.10'
21+
22+
- name: Configure git
23+
run: |
24+
git config user.name 'github-actions[bot]'
25+
git config user.email 'github-actions[bot]@users.noreply.github.com'
26+
27+
- name: Install requirements
28+
run: pip install -r docs/requirements.txt
29+
30+
- name: Publish docs
31+
run: mkdocs gh-deploy

Diff for: ‎.github/workflows/lint.yaml

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Lint
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
workflow_dispatch:
8+
9+
jobs:
10+
run-linter:
11+
timeout-minutes: 30
12+
runs-on: ubuntu-latest
13+
14+
steps:
15+
- uses: actions/checkout@v4
16+
17+
- name: Install uv
18+
uses: astral-sh/setup-uv@v3
19+
20+
- name: Set up venv
21+
run: |
22+
uv venv
23+
source .venv/bin/activate
24+
uv pip install pre-commit
25+
26+
- uses: actions/cache@v4
27+
with:
28+
path: ~/.cache/pre-commit/
29+
key: pre-commit-4|${{ env.pythonLocation }}|${{ hashFiles('.pre-commit-config.yaml') }}
30+
31+
- name: pre-commit
32+
run: |
33+
source .venv/bin/activate
34+
pre-commit run --all-files

Diff for: ‎.pre-commit-config.yaml

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
repos:
2+
- repo: https://github.com/pre-commit/pre-commit-hooks
3+
rev: v5.0.0
4+
hooks:
5+
- id: check-added-large-files
6+
- id: check-case-conflict
7+
- id: check-json
8+
- id: check-merge-conflict
9+
args: ['--assume-in-merge']
10+
- id: check-toml
11+
- id: check-yaml
12+
- id: end-of-file-fixer
13+
- id: mixed-line-ending
14+
args: ['--fix=lf']
15+
- id: sort-simple-yaml
16+
- id: trailing-whitespace
17+
- repo: https://github.com/astral-sh/ruff-pre-commit
18+
rev: 'v0.7.3'
19+
hooks:
20+
- id: ruff
21+
args: [--fix, --exit-non-zero-on-fix]
22+
- id: ruff-format
23+
- repo: https://github.com/codespell-project/codespell
24+
rev: v2.3.0
25+
hooks:
26+
- id: codespell
27+
exclude: CODE_OF_CONDUCT.md

Diff for: ‎CODE_OF_CONDUCT.md

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant 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, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and 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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

Diff for: ‎CONTRIBUTING.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Contributing to mozilla.ai Blueprints
2+
3+
We welcome contributions of all kinds! Whether you're a seasoned developer or just starting out, your help is greatly appreciated.
4+
5+
# How to Contribute
6+
7+
---

Diff for: ‎README.md

+31-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,31 @@
1-
# Blueprint-template
1+
<img src="./images/Blueprints-logo.png" alt="Project Logo" style="width:25%;">
2+
3+
# Blueprint Title
4+
5+
This blueprint guides you to ...
6+
7+
![Blueprint Diagram](./images/blueprint-diagram.png)
8+
9+
10+
## Pre-requisites
11+
12+
- **System requirements**:
13+
- OS: Windows, macOS, or Linux
14+
- Python 3.10 or higher
15+
- Minimum RAM: 4 GB
16+
- Disk space: 1 GB minimum
17+
18+
- **Dependencies**:
19+
- Dependencies listed in `requirements.txt`
20+
21+
## Installation
22+
23+
---
24+
25+
## Quick-start
26+
27+
---
28+
29+
## License
30+
31+
This project is licensed under the Apache 2.0 License. See the [LICENSE](LICENSE) file for details.

Diff for: ‎demo/app.py

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import streamlit as st
2+
3+
st.title("Blueprint Demo")

Diff for: ‎docs/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Wellcome to Blueprint docs

Diff for: ‎docs/requirements.txt

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
mkdocs
2+
mkdocs-material
3+
mkdocstrings[python]

Diff for: ‎images/Blueprints-logo.png

7.31 KB
Loading

Diff for: ‎mkdocs.yml

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
site_name: Blueprint Docs
2+
3+
nav:
4+
- Home: index.md
5+
6+
theme:
7+
name: mkdocs-material
8+
palette:
9+
primary: deep orange

Diff for: ‎requirementx.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
streamlit

0 commit comments

Comments
 (0)