diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..831835a --- /dev/null +++ b/.gitignore @@ -0,0 +1,65 @@ +# Operating System Files +.DS_Store +.DS_Store? +._* +.Spotlight-V100 +.Trashes +ehthumbs.db +Thumbs.db +*~ + +# IDE and Editor Files +.vscode/ +.idea/ +*.swp +*.swo +*.swn +*.bak +*.sublime-project +*.sublime-workspace + +# Logs +logs/ +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# Dependencies +node_modules/ +vendor/ +*.egg-info/ +dist/ +build/ + +# Environment Variables +.env +.env.local +.env.*.local + +# Temporary Files +tmp/ +temp/ +*.tmp + +# Build Artifacts +*.pyc +*.pyo +__pycache__/ +*.class +*.jar +*.war +*.ear +target/ + +# Test Coverage +coverage/ +.nyc_output/ +htmlcov/ +.coverage +*.cover + +# Package Files +*.zip +*.tar.gz +*.rar diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5f5373b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,67 @@ +# Contributing to will-glas-test + +First off, thank you for considering contributing to will-glas-test! 🎉 + +## How Can I Contribute? + +### Reporting Bugs + +Before creating bug reports, please check the issue list as you might find that you don't need to create one. When you are creating a bug report, please include as many details as possible: + +* **Use a clear and descriptive title** +* **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 if relevant** + +### 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 alternative solutions you've considered** + +### Pull Requests + +* Fill in the pull request template +* Follow the style guidelines of this project +* Write clear, concise commit messages +* Include relevant issue numbers in your PR description +* Update documentation as needed + +## Style Guidelines + +### Git Commit Messages + +* 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 after the first line + +### Code Style + +* Follow the existing code style in the repository +* Keep code clean and readable +* Comment complex logic +* Write meaningful variable and function names + +## Getting Started + +1. Fork the repository +2. Create a new branch (`git checkout -b feature/amazing-feature`) +3. Make your changes +4. Commit your changes (`git commit -m 'Add some amazing feature'`) +5. Push to the branch (`git push origin feature/amazing-feature`) +6. Open a Pull Request + +## 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 by opening an issue. + +## Questions? + +Feel free to open an issue with your question or reach out to the maintainers. + +Thank you for your contributions! ❤️ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..2ad73db --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 will-glas-test contributors + +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..11b7b88 100644 --- a/README.md +++ b/README.md @@ -1 +1,47 @@ -# will-glas-test \ No newline at end of file +# will-glas-test + +A test repository for exploring GitHub features and workflow improvements. + +## 📋 Table of Contents + +- [About](#about) +- [Getting Started](#getting-started) +- [Contributing](#contributing) +- [License](#license) + +## About + +This repository serves as a testing ground for: +- GitHub workflow experimentation +- CI/CD pipeline testing +- Documentation standards +- Community contribution practices + +## Getting Started + +### Prerequisites + +- Git installed on your local machine +- A GitHub account + +### Installation + +1. Clone the repository: + ```bash + git clone https://github.com/willglas/will-glas-test.git + cd will-glas-test + ``` + +2. Start experimenting with your own features! + +## Contributing + +We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute to this project. + +## License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. + +## 📞 Contact + +For questions or suggestions, please open an issue in this repository. \ No newline at end of file