-
Notifications
You must be signed in to change notification settings - Fork 0
feat: add community health files #51
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
eaba7fb
fix: disable node deprecation warnings in the cli via sea config
weaponsforge 6d21666
chore: add community health files
weaponsforge f32445c
chore: add script for viewing node environment
weaponsforge 64f0fee
feat: add gh issue forms
weaponsforge b4de2c3
chore: apply pr review suggestions
weaponsforge 7fc7925
chore: apply pr review suggestions
weaponsforge File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| name: Bug Report | ||
| description: Create a bug report | ||
| labels: ['bug'] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Before opening a new issue: | ||
|
|
||
| - Do a search of existing issues. | ||
| - Pull the latest updates from this repository's `dev` branch. | ||
|
|
||
| If you need help with your own project, you can start a discussion in the [Q&A Section](https://github.com/weaponsforge/send-email/discussions/categories/q-a). | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: To Reproduce | ||
| description: A step-by-step description of how to reproduce the issue, or a link to the reproducible repository. | ||
| placeholder: | | ||
| 1. Start the application in development (`npm run sendemail:dev -- text -s "Title" -c "Sample body" -r a@gmail.com`) | ||
| 2. Press enter | ||
| 3. An error appears: "[ERROR] Failed to send text email: Required clientId" | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: Current vs. Expected behavior | ||
| description: A clear and concise description of what the bug is, and what you expected to happen. | ||
| placeholder: 'Following the steps from the previous section, I expected A to happen, but I observed B instead' | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: Provide environment information | ||
| description: Please run `npm run info` in the root directory of your project and paste the results. | ||
| render: bash | ||
| placeholder: | | ||
| Node version: v24.11.0 | ||
| Platform: win32 | ||
| Arch: x64 | ||
| V8 version: 13.6.233.10-node.28 | ||
| npm version: 11.6.1 | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: dropdown | ||
| attributes: | ||
| label: Which area(s) are affected? (Select all that apply) | ||
| multiple: true | ||
| options: | ||
| - 'Not sure' | ||
| - 'CLI usage' | ||
| - 'Authentication' | ||
| - 'Email templates' | ||
| - 'Docker image' | ||
| - 'Built binaries (SEA)' | ||
| - 'Others' | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: Additional context | ||
| description: | | ||
| Any extra information that might help us investigate. | ||
| placeholder: | | ||
| I tested my reproduction against different `googleapis` releases, and the first one that introduced the bug was "v171.4.0", since reverting to "v170.0.0" works. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| blank_issues_enabled: false | ||
| contact_links: | ||
| - name: Questions? | ||
| url: https://github.com/weaponsforge/send-email/discussions | ||
| about: Ask your questions here. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| name: Feature Request | ||
| description: Suggest a new feature or improvement to the project | ||
| labels: ['enhancement'] | ||
| body: | ||
| - type: textarea | ||
| attributes: | ||
| label: What problem will this feature address? | ||
| description: A clear and concise description of what the problem is. | ||
| placeholder: | | ||
| I'm always frustrated when I can't do X | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: Describe the solution you'd like | ||
| description: A clear and concise description of what you want to happen. | ||
| placeholder: Add X to the core | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: Describe alternatives you've considered | ||
| description: A clear and concise description of any alternative solutions or features you've considered. | ||
| placeholder: | | ||
| Maybe use Y as a workaround? | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: Additional context | ||
| description: Add any other context or screenshots about the feature request here. | ||
| validations: | ||
| required: false |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| ## Summary | ||
| <!-- Provide a short summary of your changes and the motivation behind them. --> | ||
|
|
||
| ## Related Issues | ||
| <!-- List any related issues, e.g. Fixes #123 or Closes #456 --> | ||
|
|
||
| ## Type of Change | ||
| - [ ] Bug fix | ||
| - [ ] New feature | ||
| - [ ] Breaking change | ||
| - [ ] Refactor | ||
| - [ ] Documentation | ||
| - [ ] Other (please describe): | ||
|
|
||
| ## Checklist | ||
| - [ ] I have read the [CONTRIBUTING.md](https://github.com/weaponsforge/send-email/blob/dev/CONTRIBUTING.md) | ||
| - [ ] My code follows the [CODE STYLE](https://github.com/weaponsforge/send-email/blob/dev/docs/CODING_STYLE.md) of this project | ||
| - [ ] I have added tests where applicable | ||
| - [ ] I have tested my changes locally | ||
| - [ ] I have linked relevant issues | ||
| - [ ] I have added screenshots for UI changes (if applicable) | ||
|
|
||
| ## Screenshots (if applicable) | ||
| <!-- Add before/after screenshots or GIFs here --> | ||
|
|
||
| ## Additional Context | ||
| <!-- Add any other context or information about the PR here --> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
|
|
||
| # 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 weaponsforge.dev@gmail.com. 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][v2.0]. | ||
|
|
||
| Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC]. | ||
|
|
||
| For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations]. | ||
|
|
||
| [homepage]: https://www.contributor-covenant.org | ||
| [v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html | ||
| [Mozilla CoC]: https://github.com/mozilla/diversity | ||
| [FAQ]: https://www.contributor-covenant.org/faq | ||
| [translations]: https://www.contributor-covenant.org/translations |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| # Contribution Guidelines | ||
|
|
||
| Welcome to the **send-email** repository! We're excited to have you contribute to sending text and HTML-format emails more accessible via command line interface (CLI). To ensure a smooth contribution process for everyone, please follow these guidelines. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| 1. **Fork the Repository:** Start by forking the repository's `"dev"` branch to your GitHub account. This creates your own copy of the project where you can make changes. | ||
|
|
||
| 2. **Clone Your Fork:** Clone your forked repository to your local machine using Git. This allows you to work on the files locally. | ||
| ```sh | ||
| git clone https://github.com/yourusername/send-email.git | ||
| ``` | ||
|
|
||
| 3. **Set Upstream Remote:** Add the original repository as an upstream remote to your local clone. This helps you to keep your fork up to date. | ||
| ```sh | ||
| git remote add upstream https://github.com/weaponsforge/send-email.git | ||
| ``` | ||
|
|
||
| ## Making Changes | ||
|
|
||
| 1. **Create a New Branch:** Always work on a new branch for your changes. This keeps your contributions organized and separate from the main branch. | ||
| ```sh | ||
| git checkout -b feat/your-new-feature-name | ||
| ``` | ||
|
|
||
| 2. **Add Your Content:** Make your changes or additions to the project. If you're adding new content, ensure it's placed in the correct directory and follows intuitive naming conventions and TypeScript coding best practices and patterns described in the [CODING STYLE](/docs/CODING_STYLE.md). | ||
|
|
||
| > Before commiting your changes, format your code with `"npm run lint:fix"`, and ensure all updates pass the `"npm run lint"`, `"npm run transpile:noemit"` and `"npm test"` scripts. | ||
|
|
||
| 3. **Commit Your Changes:** After making your changes, commit them to your branch. Use clear and concise commit messages to describe your updates. | ||
| ```sh | ||
| git add . | ||
| git commit -m "Add a brief description of your changes" | ||
| ``` | ||
|
|
||
| 4. **Keep Your Fork Updated:** Regularly sync your fork's `"dev"` branch with the upstream repository to keep it up to date. This reduces potential merge conflicts. | ||
| ```sh | ||
| git fetch upstream | ||
| git checkout dev | ||
| git merge upstream/dev | ||
| git push origin dev | ||
| ``` | ||
|
|
||
| ## Submitting Contributions | ||
|
|
||
| 1. **Push Your Changes:** Push your changes to your fork on GitHub. | ||
| ```sh | ||
| git push origin feat/your-new-feature-name | ||
| ``` | ||
|
|
||
| 2. **Create a Pull Request (PR):** Go to the original **send-email** repository on GitHub and create a new pull request. Base your PR on your feature branch and target the `"dev"` branch of the upstream repository. | ||
|
|
||
| 3. **Describe Your Contribution:** Provide a clear and detailed description of your pull request. Include the purpose of your changes and any other relevant information. | ||
|
|
||
| 4. **Review and Collaboration:** Once your PR is submitted, the project maintainers will review your contributions. Be open to feedback and be ready to make additional changes if requested. | ||
|
|
||
| ## Guidelines | ||
|
|
||
| 1. **Quality:** Ensure your contributions are high quality, with no spelling or grammatical errors. | ||
|
|
||
| 2. **Relevance:** Content should be relevant to mostly Node.js and TypeScript - coding structure, patterns, naming conventions, optimizations, directory/folder colocation structures and conventions, and/or usage of notable Node libraries for Node.js CLI development closely following and improving this repository's [CODING STYLE](/docs/CODING_STYLE.md). | ||
|
|
||
| 3. **Working functionality:** For pull requests involving new features or major updates, ensure the changes are fully functional and optimized. Aim to keep PRs within **`~700` lines of code changes**, breaking them into smaller, self-contained parts when possible. PRs exceeding **`~1000+` lines** may be accepted when justified (e.g., major refactors or foundational features). | ||
|
|
||
| 4. **Respect:** Respect the structure and formatting of the existing project. Follow the standard ESLint rules defined in its `app/eslint.config.mjs` file. | ||
|
|
||
| Thank you for contributing to the **send-email** repository. Your efforts help in sending emails more accessible for everyone. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| ## Reporting Security Issues | ||
|
|
||
| **Please do not report security vulnerabilities through public GitHub issues.** | ||
|
|
||
| If you believe you have found a security vulnerability, we encourage you to let the Maintainer know right away. | ||
|
|
||
| They will investigate all legitimate reports and do our best to quickly fix the problem. | ||
|
|
||
| Email `weaponsforge.dev@gmail.com` to disclose any security vulnerabilities. | ||
|
|
||
| You should receive a response within 3 business days. If for some reason you do not, please follow up via email to ensure they received your original message. | ||
|
|
||
| Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue: | ||
|
|
||
| - Type of issue (e.g. leaked secrets, malware installation, CVE, cross-site scripting, etc.) | ||
| - Full paths of source file(s) related to the manifestation of the issue | ||
| - The location of the affected source code (tag/branch/commit or direct URL) | ||
| - Any special configuration required to reproduce the issue | ||
| - Step-by-step instructions to reproduce the issue | ||
| - Proof-of-concept or exploit code (if possible) | ||
| - Impact of the issue, including how an attacker might exploit the issue | ||
|
|
||
| This information will help the Maintainer triage your report more quickly. |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.