chore: Sync

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+hola@logico.com.ar.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Contributing to tokyo-night-tmux
+
+Thank you for your interest in contributing to the tokyo-night-tmux project! We welcome contributions from the community to help improve and enhance the project. To ensure a smooth collaboration process, please follow the guidelines outlined below.
+
+## Before Making a Pull Request
+
+1. **Open an Issue**: Before starting to work on a new feature or bug fix, please open an issue on the GitHub repository. This allows for discussion and helps avoid duplication of efforts. Clearly describe the problem or feature you want to address in the issue.
+
+2. **Discuss and Assign**: Once an issue is opened, the maintainers will review it and provide feedback. If the issue is approved, it will be assigned to you, indicating that you can start working on it.
+
+## Making a Pull Request
+
+1. **Fork the Repository**: Fork the tokyo-night-tmux repository to your own GitHub account.
+
+2. **Create a Branch**: Create a new branch from the `next` branch in your forked repository. Use a descriptive name for your branch that reflects the purpose of your changes.
+
+3. **Make Changes**: Implement your changes or additions to the codebase in your branch. Ensure that your code follows the project's coding style and conventions.
+
+4. **Pre-Commit Checks**: Before committing your changes, run the pre-commit checks to ensure your code passes all the necessary tests and checks. Run the following command:
+   ```
+   pre-commit run --all-files
+   ```
+   Make sure all pre-commit checks pass successfully.
+
+5. **Commit Changes**: Commit your changes with a clear and descriptive commit message. Follow the Conventional Commits specification for commit message formatting. Refer to the [Conventional Commits summary](https://www.conventionalcommits.org/en/v1.0.0/#summary) for more details.
+
+6. **Push Changes**: Push your branch to your forked repository on GitHub.
+
+7. **Open a Pull Request**: Open a pull request from your branch to the `next` branch of the main tokyo-night-tmux repository. Provide a clear title and description for your pull request, explaining the changes you have made and referencing any related issues.
+
+8. **Resolve Conflicts**: If your pull request has conflicts with the `next` branch, please resolve them by rebasing your branch on top of the latest `next` branch and resolving any merge conflicts that arise.
+
+9. **Review and Feedback**: The maintainers will review your pull request and provide feedback or request changes if necessary. Please be responsive to the feedback and make the required changes.
+
+10. **Merge**: Once your pull request has been approved and passes all the necessary checks, it will be merged into the `next` branch by the maintainers.
+
+## Important Notes
+
+- All pull requests must be made against the `next` branch. Pull requests made directly to the `main` branch will not be accepted.
+- Ensure that your pull request does not have any conflicts with the `next` branch. Resolve any conflicts before submitting the pull request.
+- Make sure your pull request passes all the pre-commit checks by running `pre-commit run --all-files` before submitting.
+- Follow the Conventional Commits specification for commit message formatting to maintain a consistent and informative commit history.
+
+Thank you for your contribution to tokyo-night-tmux! We appreciate your effort and look forward to collaborating with you.

README.md

@@ -13,76 +13,84 @@ This is a very opinionated project, as I am a Tech Lead, this theme is very deve
 
 ## Requirements
 
-### Nerd Fonts
+This theme requires the following:
 
-This theme requires the use of a patched font with Nerd Font. Ensure your terminal is set to use one before installing this theme. Any patched font will do. See
-[`nerdfonts.com`](https://www.nerdfonts.com/) for more information.
+- [Noto Sans] and one of any patched [Nerd Fonts]
+- GNU [coreutils] and [bc]
+- Bash 4.0 or newer
 
-### Noto Fonts
+### macOS
 
-This theme requires the Noto fonts to be installed on your operating system. Make sure your operating system has the needed font and is configured to use one.
+For macOS, you can install all dependencies via [Homebrew]:
 
-### GNU bc
-This theme requires the [`GNU bc`](https://www.gnu.org/software/bc/) for precise mathematical calculation of network speed, [Tokyo-night-tmux](https://github.com/janoamaral/tokyo-night-tmux) also shows the real time network speed in right side of status bar.
+```bash
+brew tap homebrew/cask-fonts
+brew install --cask font-monaspace-nerd-font font-noto-sans
+brew install bash bc coreutils gawk gsed
+```
+
+### Linux
+
+GNU coreutils are already installed on most Linux distributions. You can
+install `bc` via your package manager. For example, on Arch Linux:
 
 ```bash
 pacman -S bc
 ```
-see documentation for installing [`GNU bc`](https://www.gnu.org/software/bc/) in other Operation system.
+
+Check documentation for installing [bc] on other operating systems.
 
 ## Installation using TPM
 
 In your `tmux.conf`:
+
 ```bash
 set -g @plugin "janoamaral/tokyo-night-tmux"
 ```
 
 ## Configuration
 
-#### Number styles
+### Number styles
 
-Run this
+Run these commands in your terminal:
 
 ```bash
 tmux set @tokyo-night-tmux_window_id_style digital
 tmux set @tokyo-night-tmux_pane_id_style hsquare
 tmux set @tokyo-night-tmux_zoom_id_style dsquare
 ```
 
-or add this lines to your  `.tmux.conf`
+Alternatively, add these lines to your  `.tmux.conf`:
 
 ```bash
 set -g @tokyo-night-tmux_window_id_style digital
 set -g @tokyo-night-tmux_pane_id_style hsquare
 set -g @tokyo-night-tmux_zoom_id_style dsquare
 ```
 
-
-## Widgets
+### Widgets
 
 For widgets add following lines in you `.tmux.conf`
 
-
 #### Date and Time widget
 
-**Widget enabled by default**
+This widget is enabled by default. To disable it:
 
-set value 0 to disable
 ```bash
 set -g @tokyo-night-tmux_show_datetime 0
 set -g @tokyo-night-tmux_date_format MYD
 set -g @tokyo-night-tmux_time_format 12H
 ```
 
-#### Available Options
+##### Available Options
+
 - `YMD`: (Year Month Day), 2024-01-31
 - `MDY`: (Month Day Year), 01-31-2024
 - `DMY`: (Day Month Year), 31-01-2024
 
 - `24H`: 18:30
 - `12H`: 6:30 PM
 
-
 #### Now Playing widget
 
 ```bash
@@ -93,7 +101,7 @@ set -g @tokyo-night-tmux_show_music 1
 
 ```bash
 set -g @tokyo-night-tmux_show_netspeed 1
-set -g @tokyo-night-tmux_netspeed_iface "wlan0" # your network interface, find with ip link
+set -g @tokyo-night-tmux_netspeed_iface "wlan0" # find your interface with ip link
 ```
 
 #### Path Widget
@@ -111,30 +119,30 @@ set -g @tokyo-night-tmux_battery_name "BAT1"  # some linux distro have 'BAT0'
 set -g @tokyo-night-tmux_battery_low_threshold 21 # default
 ```
 
-set variables value `0` to disable the widget, Remember to restart the `tmux` after changing values.
+Set variable value `0` to disable the widget. Remember to restart `tmux` after
+changing values.
 
-## The styles:
+## Styles
 
 - `none`: no style, default font
-- `digital`: 7 segment number (🯰...🯹) (needs [Unicode support](https://github.com/janoamaral/tokyo-night-tmux/issues/36#issuecomment-1907072080)) 
+- `digital`: 7 segment number (🯰...🯹) (needs [Unicode support](https://github.com/janoamaral/tokyo-night-tmux/issues/36#issuecomment-1907072080))
 - `roman`: roman numbers (󱂈...󱂐) (needs nerdfont)
 - `fsquare`: filled square (󰎡...󰎼) (needs nerdfont)
 - `hsquare`: hollow square (󰎣...󰎾) (needs nerdfont)
 - `dsquare`: hollow double square (󰎡...󰎼) (needs nerdfont)
 - `super`: superscript symbol (⁰...⁹)
-- `sub`: subscript symbols (₀...₉) 
-
+- `sub`: subscript symbols (₀...₉)
 
 ### New tokyonight Highlights ⚡
 
-Everything works out the box now. No need to modify anything and colors are hardcoded, 
+Everything works out the box now. No need to modify anything and colors are hardcoded,
 so it's independent of terminal theme.
 
 - Local git stats.
 - Web based git server (GitHub/GitLab) stats.
-    - Open PR count
-    - Open PR reviews count 
-    - Issue count
+  - Open PR count
+  - Open PR reviews count
+  - Issue count
 - Remote branch sync indicator (you will never forget to push or pull again 🤪).
 - Great terminal icons.
 - Prefix highlight incorporated.
@@ -168,12 +176,20 @@ Legacy tokyo-night
 
 ## Contributing
 
-This project is open to contributions. Please feel free to open an issue or a pull request.
+> [!IMPORTANT]  
+> Please read the [contribution guide first](CONTRIBUTING.md).
 
-Ensure your editor is configured appropriately to consider the provided `.editorconfig` file.
-[pre-commit] hooks are also provided to ensure code consistency, and will be run against any raised PRs.
+Feel free to open an issue or pull request with any suggestions or improvements.
 
+Ensure your editor follows the style guide provided by `.editorconfig`.
+[pre-commit] hooks are also provided to ensure code consistency, and will be
+run against any raised PRs.
 
 [cmus]: https://cmus.github.io/
 [nowplaying-cli]: https://github.com/kirtan-shah/nowplaying-cli
 [pre-commit]: https://pre-commit.com/
+[Noto Sans]: https://fonts.google.com/noto/specimen/Noto+Sans
+[Nerd Fonts]: https://www.nerdfonts.com/
+[coreutils]: https://www.gnu.org/software/coreutils/
+[bc]: https://www.gnu.org/software/bc/
+[Homebrew]: https://brew.sh/

SECURITY.md

@@ -0,0 +1,44 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+We take the security of our open-source project, tokyo-night-tmux, very seriously. If you discover a potential security vulnerability in our codebase, we appreciate your help in disclosing it to us responsibly.
+
+To report a security vulnerability, please follow these steps:
+
+1. Email us at [hola@logico.com.ar](mailto:hola@logico.com.ar) with a detailed description of the vulnerability you have discovered. Please include the following information:
+   - A clear and concise description of the vulnerability
+   - Steps to reproduce the vulnerability
+   - Potential impact of the vulnerability
+   - Any additional information that may help us understand and address the issue
+
+2. We will acknowledge receipt of your report within 48 hours and provide an estimated timeline for addressing the vulnerability.
+
+3. We kindly request that you do not disclose the vulnerability publicly until we have had sufficient time to investigate and address the issue.
+
+4. Once the vulnerability has been addressed, we will publicly acknowledge your responsible disclosure, if you wish.
+
+## Supported Versions
+
+We actively maintain and support the latest version of tokyo-night-tmux. We encourage all users to keep their installations up to date with the latest release to ensure they have the most recent security fixes.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| Latest  | :white_check_mark: |
+| < Latest| :x:                |
+
+## Security Best Practices
+
+To ensure the security of your tokyo-night-tmux installation, we recommend following these best practices:
+
+- Keep your tokyo-night-tmux installation up to date with the latest version.
+- Regularly review and update any dependencies used by tokyo-night-tmux to address any known vulnerabilities.
+- Follow secure coding practices and guidelines when contributing to the tokyo-night-tmux codebase.
+- Use strong and unique passwords for any accounts associated with tokyo-night-tmux.
+- Regularly monitor your installation for any suspicious activity or unauthorized access attempts.
+
+## Acknowledgments
+
+We would like to express our gratitude to the security researchers and community members who responsibly disclose vulnerabilities to us. Your efforts help us maintain the security and integrity of tokyo-night-tmux.
+
+If you have any further questions or concerns regarding the security of tokyo-night-tmux, please don't hesitate to contact us at [hola@logico.com.ar](mailto:hola@logico.com.ar).