diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..fdd39bde9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,33 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '[BUG] ' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Download ISO from '...' +2. Install on '...' +3. Configure '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**System Information:** + - ISO Version: [e.g., 2023.12.01] + - Hardware: [e.g., ThinkPad X1 Carbon] + - BIOS/UEFI Version: [if relevant] + - Installation Method: [e.g., USB boot, VM] + +**Additional context** +Add any other context about the problem here, such as: +- Relevant system logs +- Error messages +- Screenshots diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..8f423a1c8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,26 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '[FEATURE] ' +labels: enhancement +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Implementation details (optional)** +If you have technical knowledge about how this could be implemented: +- Required packages +- Configuration changes +- System modifications + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/workflows/build-check.yml b/.github/workflows/build-check.yaml similarity index 100% rename from .github/workflows/build-check.yml rename to .github/workflows/build-check.yaml diff --git a/.github/workflows/build.yml b/.github/workflows/build.yaml similarity index 100% rename from .github/workflows/build.yml rename to .github/workflows/build.yaml diff --git a/.github/workflows/dockerfile-check.yml b/.github/workflows/dockerfile-check.yaml similarity index 100% rename from .github/workflows/dockerfile-check.yml rename to .github/workflows/dockerfile-check.yaml diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..9a539f011 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,50 @@ +# Contributing to Arch Linux Without the Beeps + +We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: + +- Reporting a bug +- Discussing the current state of the code +- Submitting a fix +- Proposing new features +- Becoming a maintainer + +## Development Process + +We use GitHub to host code, to track issues and feature requests, as well as accept pull requests. + +1. Fork the repo and create your branch from `main`. +2. If you've added code that should be tested, add tests. +3. If you've changed APIs, update the documentation. +4. Ensure the test suite passes. +5. Make sure your code follows the existing style. +6. Issue that pull request! + +## Pull Request Process + +1. Update the README.md with details of changes to the interface, if applicable. +2. Update the version numbers in any examples files and the README.md to the new version. +3. The PR will be merged once you have the sign-off of at least one other developer. + +## Any contributions you make will be under our License +In short, when you submit code changes, your submissions are understood to be under the same [License](LICENSE) that covers the project. Feel free to contact the maintainers if that's a concern. + +## Report bugs using GitHub's [issue tracker](../../issues) +We use GitHub issues to track public bugs. Report a bug by [opening a new issue](../../issues/new). + +## Write bug reports with detail, background, and sample code + +**Great Bug Reports** tend to have: + +- A quick summary and/or background +- Steps to reproduce + - Be specific! + - Give sample code if you can. +- What you expected would happen +- What actually happens +- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) + +## License +By contributing, you agree that your contributions will be licensed under its License. + +## References +This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md). diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 000000000..e4b6ece7d --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,49 @@ +# Security Policy + +## Supported Versions + +This project provides ISO builds of Arch Linux. We maintain and provide security updates for: + +| Version | Supported | +| ------- | ------------------ | +| Latest Release | :white_check_mark: | +| Older Releases | :x: | + +## Reporting a Vulnerability + +We take the security of this project seriously. If you believe you have found a security vulnerability, please follow these steps: + +1. **Do Not** open a public issue on GitHub +2. Send a description of the vulnerability to [project maintainer's email] +3. Include the following information: + - Type of issue + - Full paths of source file(s) related to the issue + - The location of the affected source code + - 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 + +## Security Measures + +Our ISO builds implement several security measures: + +1. **Verification**: All ISOs are provided with SHA256 checksums +2. **Updates**: The ISO is rebuilt daily with the latest security updates +3. **Minimal Surface**: Only essential packages are included +4. **Docker Security**: The build process runs in an isolated container + +## Best Practices + +When using this ISO: + +1. Always verify the ISO checksum before installation +2. Keep your system updated regularly +3. Follow Arch Linux security guidelines +4. Implement appropriate system hardening measures + +## Security Updates + +- Security updates are handled through the standard Arch Linux package management system +- Critical security issues will be addressed as soon as possible +- Updates that affect the ISO build process will trigger a new build automatically