Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
951e5c3
feat: Implement notes and clipboard management features
itzsleepyy Sep 22, 2025
12a31ca
Revert "feat: Implement notes and clipboard management features"
itzsleepyy Sep 22, 2025
79c7e35
Feature quick notes clipboard history (#3)
itzsleepyy Sep 24, 2025
87f8153
Revert "Feature quick notes clipboard history (#3)"
itzsleepyy Sep 25, 2025
c68f3b5
Release version v2.7.3
Alexander5015 Nov 24, 2025
339ac65
Add version v2.7.3 to bug report template
Alexander5015 Nov 25, 2025
6ac7683
Refine bug report form and add music source options
Alexander5015 Nov 28, 2025
859d218
Refine music source and app input fields
Alexander5015 Nov 28, 2025
3739a9e
Update music source options in bug report form
Alexander5015 Nov 28, 2025
51ac0c1
Update crowdin.yml
Alexander5015 Nov 29, 2025
5a2e845
Icon hyperlink correction in README.md
adam-dziuk Dec 3, 2025
b7881a3
Merge pull request #891 from adam-dziuk/feature/readme-icon-hyperlink…
Alexander5015 Dec 3, 2025
7386791
WIP: Add contributing guidelines to CONTRIBUTING.md
Alexander5015 Dec 6, 2025
87ce277
Simplify contributing instructions in README
Alexander5015 Dec 6, 2025
de34e76
Revise contributing guidelines for better clarity
Alexander5015 Dec 6, 2025
6604ad6
Add feature request form for better user input
Alexander5015 Dec 10, 2025
d503177
Fix formatting in feature request issue template
Alexander5015 Dec 10, 2025
ce2c34e
Fix YAML syntax for feature request template
Alexander5015 Dec 10, 2025
b6a8b35
Fix formatting and capitalization in feature request template
Alexander5015 Dec 10, 2025
5bae205
Disable old feature template
Alexander5015 Dec 10, 2025
eeef0e6
Add fancy DMG creation support with dmgbuild and background image
Alexander5015 Dec 12, 2025
8547104
Refactor dmgbuild installation to use a virtual environment for isola…
Alexander5015 Dec 12, 2025
37ebd38
Ensure virtual environment is used for dmgbuild in DMG creation steps
Alexander5015 Dec 12, 2025
d3f66c2
Merge branch 'TheBoredTeam:dev' into dev
itzsleepyy Jan 14, 2026
a121652
feat: Implement unified Extensions Hub and animated empty state
itzsleepyy Jan 14, 2026
f7a4161
fix: Properly disable Shelf extension and implement Extensions Hub
itzsleepyy Jan 14, 2026
4c7cc4b
feat: Implement Extensions Marketplace with improved navigation UX
itzsleepyy Jan 14, 2026
04773ff
fix: Implement custom accent color support across extension UI
itzsleepyy Jan 15, 2026
be081b7
Merge branch 'TheBoredTeam:main' into feature/extensions
itzsleepyy Jan 15, 2026
e0efc09
feat: introduce Camera Mirror extension with configurable settings an…
itzsleepyy Jan 16, 2026
dee743d
chore: Clarify mock extension data as non-functional demo placeholder…
itzsleepyy Jan 16, 2026
53dd318
Merge branch 'dev' into feature/extension-manager
itzsleepyy Jan 16, 2026
6c2a76e
Remove the "Additional features" section from `SettingsView.swift` an…
itzsleepyy Jan 16, 2026
ed97321
Fix to extension switch having its state reset. Cleaned boring mirror…
itzsleepyy Jan 16, 2026
ed64d99
Merge branch 'dev' into feature/extension-manager2
itzsleepyy Feb 4, 2026
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
28 changes: 27 additions & 1 deletion .github/ISSUE_TEMPLATE/1-bug-report-form.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,13 @@ body:
- type: dropdown
id: version
attributes:
label: BoringNotch Version
label: Boring Notch Version
description: >-
What version of our software are you running? (Go to ✦ in the menu bar >
Settings > About)
options:
- Select a version
- v2.7.3
- v2.7.2
- v2.7.1
- v2.7
Expand All @@ -50,6 +51,31 @@ body:
description: Go to  > About This Mac
validations:
required: true
- type: dropdown
id: music-source
attributes:
label: Music Source? (If relevant)
description: >-
If this issue is related to music, what music source did you select in Boring Notch settings?
options:
- Now Playing
- Apple Music
- Spotify
- YouTube Music
validations:
required: false
- type: input
id: music-app
attributes:
label: Music App (If using Now Playing)
validations:
required: false
- type: input
id: music-website
attributes:
label: Website (If using browser for music)
validations:
required: false
- type: textarea
id: logs
attributes:
Expand Down
80 changes: 80 additions & 0 deletions .github/ISSUE_TEMPLATE/1-feature-request-form.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
name: Feature Request
description: Suggest a new idea or enhancement for Boring Notch
title: "[FEATURE] "
labels: []

body:
- type: markdown
attributes:
value: |
## Feature Request

Thanks for helping make **Boring Notch** better! Please check [existing requests](https://github.com/TheBoredTeam/boring.notch/issues?q=is%3Aissue) before submitting to avoid duplicates.

- type: textarea
id: problem
attributes:
label: Is your feature request related to a problem?
description: |
Please provide a clear description of the problem or pain point this feature would address.

**Example:** "I often miss my next meeting because I work in full-screen mode and can't see the system clock or calendar notifications."
placeholder: "I'm frustrated when... or It would be great if..."
validations:
required: true

- type: textarea
id: solution
attributes:
label: Describe the solution you'd like
description: |
How should Boring Notch handle this? Describe the behavior, UI, or interaction you imagine in detail.

**Example:** "When a meeting is starting in 5 minutes, the notch could expand slightly to show a countdown timer or the meeting title."
placeholder: "I would like the notch to..."
validations:
required: true

- type: textarea
id: use-cases
attributes:
label: Use cases & user scenarios
description: |
Describe specific scenarios where this feature would be valuable. Who would benefit from this and how often would it be used?

**Example:** "Remote workers who attend 5+ video meetings daily would use this constantly. Students could benefit during online classes."
placeholder: "This would help users who..."
validations:
required: false

- type: textarea
id: additional-context
attributes:
label: Additional context & screenshots
description: |
Add any other context, mockups, wireframes, or screenshots about the feature request here. Visuals are incredibly helpful!

You can drag and drop images directly into this field.
placeholder: "Here is a mockup of how the hover state should look..."
validations:
required: false

- type: checkboxes
id: contribution
attributes:
label: Willingness to contribute
description: "We love community contributions! Would you be willing to help build this?"
options:
- label: "Yes, I can write the code for this feature"
- label: "Yes, I can help with design/mockups"

- type: checkboxes
id: checklist
attributes:
label: Pre-submission checklist
description: "Please confirm the following before submitting:"
options:
- label: "I have searched existing issues to ensure this isn't a duplicate"
required: true
- label: "I have provided sufficient detail for the team to understand the request"
required: true
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!--- This issue template is being replaced with the updated issue form for new features -->
---
name: Feature request
about: Suggest an idea for this project
Expand Down
21 changes: 16 additions & 5 deletions .github/workflows/manual_build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -75,13 +75,24 @@ jobs:
EOF
xcodebuild -exportArchive -archivePath "${{ env.projname }}.xcarchive" -exportPath Release -exportOptionsPlist "$TEMP_PLIST"

- name: Install dmgbuild (use virtualenv)
run: |
# Create an isolated venv
VENV_DIR="$RUNNER_TEMP/venv"
python3 -m venv "$VENV_DIR"
source "$VENV_DIR/bin/activate"
python -m pip install --upgrade pip setuptools wheel
python -m pip install "dmgbuild[badge_icons]"

- name: Create DMG
run: |
cd Release
hdiutil create -volname "boringNotch" \
-srcfolder "${{ env.projname }}.app" \
-ov -format UDZO \
"${{ env.projname }}.dmg"
# Ensure venv created in previous step is used (dmgbuild installed there)
VENV_DIR="$RUNNER_TEMP/venv"
if [ -d "$VENV_DIR" ]; then
export PATH="$VENV_DIR/bin:$PATH"
fi
chmod +x Configuration/dmg/create_dmg.sh
./Configuration/dmg/create_dmg.sh "Release/${{ env.projname }}.app" "Release/${{ env.projname }}.dmg" "${{ env.projname }}"

- name: Upload DMG artifact
uses: actions/upload-artifact@v4
Expand Down
22 changes: 17 additions & 5 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -245,13 +245,25 @@ jobs:
exit 1
fi
echo "Found generate_appcast at $TOOL_PATH"
- name: Install dmgbuild (use virtualenv)
run: |
# Create an isolated venv
VENV_DIR="$RUNNER_TEMP/venv"
python3 -m venv "$VENV_DIR"
# Install into the venv
source "$VENV_DIR/bin/activate"
python -m pip install --upgrade pip setuptools wheel
python -m pip install "dmgbuild[badge_icons]"

- name: Create DMG
run: |
cd Release
hdiutil create -volname "boringNotch ${{ needs.preparation.outputs.version }}" \
-srcfolder "${{ env.projname }}.app" \
-ov -format UDZO \
"${{ env.projname }}.dmg"
# Ensure venv created in previous step is used (dmgbuild installed there)
VENV_DIR="$RUNNER_TEMP/venv"
if [ -d "$VENV_DIR" ]; then
export PATH="$VENV_DIR/bin:$PATH"
fi
chmod +x Configuration/dmg/create_dmg.sh
./Configuration/dmg/create_dmg.sh "Release/${{ env.projname }}.app" "Release/${{ env.projname }}.dmg" "boringNotch ${{ needs.preparation.outputs.version }}"
- name: Upload DMG artifact
uses: actions/upload-artifact@v4
with:
Expand Down
130 changes: 130 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
# Contributing

Thank you for taking the time to contribute! ❤️

These guidelines help streamline the contribution process for everyone involved. By following them, you'll make it easier for maintainers to review your work and collaborate with you effectively.

You can contribute in many ways: writing code, improving documentation, reporting bugs, requesting features, or creating tutorials and blog posts. Every contribution, large or small, helps make Boring Notch better.

## Table of Contents

- [Localizations](#localizations)
- [Contributing Code](#contributing-code)
- [Before You Start](#before-you-start)
- [Setting Up Your Environment](#setting-up-your-environment)
- [Making Changes](#making-changes)
- [Pull Requests](#pull-requests)
<!-- - [Code Style Guidelines](#code-style-guidelines) -->
- [Reporting Bugs](#reporting-bugs)
- [Feature Requests](#feature-requests)
- [Getting Help](#getting-help)

## Localizations

Please submit all translations to [Crowdin](https://crowdin.com/project/boring-notch). New strings added to the `dev` branch from code changes will sync automatically to Crowdin, and Crowdin will automatically open a new PR with translations to allow us to integrate them.

## Contributing Code

### Before You Start

- **Check existing issues**: Before creating a new issue or starting work, search existing issues to avoid duplicates.
- **Discuss major changes**: For significant features or major changes, please open an issue first to discuss your approach with maintainers and the community.
<!-- - **Review the code style**: Familiarize yourself with our code style guidelines below to ensure consistency. -->

### Setting Up Your Environment

1. **Fork the repository**: Click the "Fork" button at the top of the repository page to create your own copy.

2. **Clone your fork**:
```bash
git clone https://github.com/{your-username}/boring.notch.git
cd boring.notch
```
Replace `{your-username}` with your GitHub username.

3. **Switch to the `dev` branch**:
```bash
git checkout dev
```
All code contributions should be based on the `dev` branch, not `main`. (documentation corrections or improvements can be based on `main`)

5. **Create a new feature branch**:
```bash
git checkout -b feature/{your-feature-name}
```
Replace `{your-feature-name}` with a descriptive name. Use lowercase letters, numbers, and hyphens only (e.g., `feature/add-dark-mode` or `fix/notification-crash`).

### Making Changes

1. **Make your changes**: Implement your feature or bug fix. Write clean, well-documented code <!-- following the project's style guidelines. -->

2. **Test your changes**: Ensure your changes work as expected and don't break existing functionality.

3. **Commit your changes**:
```bash
git add .
git commit -m "Add descriptive commit message"
```
Write clear, concise commit messages that explain what your changes do and why.

4. **Keep your branch up to date**:
Regularly sync your branch with the latest changes from the `dev` branch to avoid conflicts.

5. **Push to your fork**:
```bash
git push origin feature/{your-feature-name}
```

### Pull Requests

1. **Create a pull request**: Go to the original repository and click "New Pull Request." Select your feature branch and set the base branch to `dev`.

2. **Write a detailed description**: Your PR should include:
- A clear title summarizing the changes
- A detailed description of what was changed and why
- Reference to any related issues (e.g., "Fixes #123" or "Relates to #456")
- Screenshots or screen recordings for UI changes

3. **Respond to feedback**: Maintainers may request changes.

4. **Be patient**: Reviews take time. Maintainers will get to your PR as soon as they can.

<!-- ## Code Style Guidelines

- Follow the existing code style and conventions used in the project
- Write clear, self-documenting code with meaningful variable and function names
- Add comments for complex logic or non-obvious implementations
- Ensure your code is properly formatted before committing
- Remove any debugging code, console logs, or commented-out code before submitting -->

## Reporting Bugs

When reporting bugs, please include:

- A clear, descriptive title
- Steps to reproduce the issue
- Expected behavior vs. actual behavior
- Screenshots or error messages if applicable
- Your environment details (OS version, app version, etc.)

## Feature Requests

Feature requests are welcome! Please:

- Check if the feature has already been requested
- Clearly describe the feature and its use case
- Explain why this feature would be valuable to users
- Be open to discussion and alternative approaches

## Getting Help

If you need help or have questions:

- Check the project documentation
- Search existing issues for similar questions
- Open a new issue with the "question" label
- Join our [community Discord server](https://discord.com/servers/boring-notch-1269588937320566815)

---

Thank you for contributing to Boring Notch! Your efforts help make this project better for everyone. 🎉
Binary file added Configuration/dmg/.background/background.tiff
Binary file not shown.
Loading