diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..210b0f5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,73 @@ +# Operating System Files +.DS_Store +.DS_Store? +._* +.Spotlight-V100 +.Trashes +ehthumbs.db +Thumbs.db +*~ + +# IDE and Editor Files +.vscode/ +.idea/ +*.swp +*.swo +*~ +.project +.classpath +.settings/ +*.sublime-project +*.sublime-workspace + +# Logs +logs/ +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# Runtime data +pids/ +*.pid +*.seed +*.pid.lock + +# Dependency directories +node_modules/ +vendor/ +bower_components/ + +# Build outputs +dist/ +build/ +out/ +target/ +*.class +*.pyc +__pycache__/ +*.py[cod] +*$py.class + +# Package files +*.jar +*.war +*.ear +*.zip +*.tar.gz +*.rar + +# Environment files +.env +.env.local +.env.*.local + +# Coverage directory +coverage/ +*.coverage +.nyc_output/ + +# Temporary files +tmp/ +temp/ +*.tmp diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..555b80f --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,127 @@ +# 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. +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. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5f92241 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,77 @@ +# Contributing to will-glas-test + +Thank you for considering contributing to this project! We appreciate your interest in making this project better. + +## Code of Conduct + +This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers. + +## How Can I Contribute? + +### Reporting Bugs + +Before creating bug reports, please check existing issues to avoid duplicates. When you create a bug report, please include as many details as possible: + +- **Use a clear and descriptive title** for the issue +- **Describe the exact steps to reproduce the problem** +- **Provide specific examples** to demonstrate the steps +- **Describe the behavior you observed** and what behavior you expected +- **Include screenshots or animated GIFs** if relevant +- **Include your environment details** (OS, browser, version, etc.) + +### Suggesting Enhancements + +Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, please include: + +- **Use a clear and descriptive title** +- **Provide a detailed description** of the suggested enhancement +- **Explain why this enhancement would be useful** +- **List any similar features** in other projects if applicable + +### Pull Requests + +1. Fork the repository and create your branch from `main` +2. Make your changes in your forked repository +3. Ensure your code follows the existing style conventions +4. Test your changes thoroughly +5. Commit your changes with clear, descriptive commit messages +6. Push your changes to your fork +7. Submit a pull request to the main repository + +#### Pull Request Guidelines + +- **Keep pull requests focused** - one feature or fix per PR +- **Write clear commit messages** - describe what and why, not how +- **Update documentation** if you're adding or changing features +- **Follow the existing code style** and conventions +- **Test your changes** before submitting +- **Reference any related issues** in your PR description + +### Commit Message Guidelines + +We follow these commit message conventions: + +- Use the present tense ("Add feature" not "Added feature") +- Use the imperative mood ("Move cursor to..." not "Moves cursor to...") +- Limit the first line to 72 characters or less +- Reference issues and pull requests liberally after the first line + +## Development Process + +1. Clone the repository +2. Create a new branch for your changes +3. Make your changes +4. Test your changes +5. Submit a pull request + +## Code Review Process + +The maintainers will review your pull request and may request changes or provide feedback. Please be patient and responsive to feedback. + +## Questions? + +Feel free to open an issue for any questions or concerns. We're here to help! + +## Recognition + +All contributors will be recognized in the project. Thank you for your contributions! diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a037242 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 Will Glas + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index cb3e76a..ba7b1aa 100644 --- a/README.md +++ b/README.md @@ -1 +1,42 @@ -# will-glas-test \ No newline at end of file +# will-glas-test + +A test repository for demonstrating best practices and exploring GitHub features. + +## About + +This repository serves as a testing ground for various development workflows, tools, and GitHub features. + +## Getting Started + +To get started with this repository: + +1. Clone the repository: + ```bash + git clone https://github.com/willglas/will-glas-test.git + ``` + +2. Navigate to the project directory: + ```bash + cd will-glas-test + ``` + +## Usage + +This is a test repository. Feel free to explore the code and documentation. + +## Contributing + +Contributions are welcome! Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests. + +## License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. + +## Support + +If you have any questions or need help, please open an issue in this repository. + +## Acknowledgments + +- Thanks to all contributors who help improve this project +- Inspired by open source best practices \ No newline at end of file diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..b5bca5d --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,70 @@ +# Security Policy + +## Supported Versions + +This section describes which versions of the project are currently being supported with security updates. + +| Version | Supported | +| ------- | ------------------ | +| main | :white_check_mark: | + +## Reporting a Vulnerability + +We take the security of our project seriously. If you believe you have found a security vulnerability, please report it to us as described below. + +### How to Report a Security Vulnerability + +**Please do not report security vulnerabilities through public GitHub issues.** + +Instead, please report them via GitHub Security Advisories: + +1. Navigate to the repository's Security tab +2. Click on "Report a vulnerability" +3. Fill in the details of the vulnerability + +Alternatively, you can email the maintainers directly if you prefer. + +### What to Include + +When reporting a vulnerability, please include: + +- Type of vulnerability +- Full paths of source file(s) related to the manifestation of the vulnerability +- 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 it + +### What to Expect + +- You will receive a response acknowledging your report within 48 hours +- We will investigate and validate the vulnerability +- We will work on a fix and coordinate the disclosure timeline with you +- You will be credited for the discovery (unless you prefer to remain anonymous) + +## Security Update Process + +When a security vulnerability is fixed: + +1. A security advisory will be published +2. The fix will be released as soon as possible +3. All users will be notified to update their installations + +## Security Best Practices + +When contributing to this project, please follow these security best practices: + +- Never commit sensitive data (passwords, API keys, tokens) to the repository +- Keep dependencies up to date +- Follow secure coding practices +- Review code changes carefully before merging +- Use environment variables for sensitive configuration + +## Disclosure Policy + +- We will coordinate with you regarding the disclosure timeline +- We prefer to fully remediate vulnerabilities before public disclosure +- We will credit security researchers who report valid vulnerabilities (unless they prefer anonymity) + +Thank you for helping keep this project and its users safe!