diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..46b02b7 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,21 @@ + + +## What & why + + + +## Related issue + + +Closes # + +## Checklist + +- [ ] Strict build passes: `hugo --gc --minify --panicOnWarning --baseURL "http://localhost/"` +- [ ] Link/anchor/image check passes: `htmltest` +- [ ] Copy changes were made in `data/content.yaml`, not the templates (where applicable) +- [ ] Docs/README updated for any user-facing change +- [ ] This PR is focused on a single logical change diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..6c09f05 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,45 @@ +# Contributing to the P2Pool Starter Stack site + +Thanks for taking the time to contribute! Whether it's fixing a typo, tweaking copy, +or reworking a layout, contributions are very welcome. This guide covers the workflow. + +## Before you start + +- **Found a bug or have an idea?** Open an issue first. For anything beyond a small fix, + please discuss it in an issue before writing code — it saves everyone time. +- Check the [open issues](https://github.com/p2pool-starter-stack/p2pool-starter-stack.github.io/issues) + to see if someone's already on it. + +## Dev environment + +You need [Hugo **extended**](https://gohugo.io/installation/) (≥ 0.162). On macOS: +`brew install hugo`. + +```bash +hugo server # live reload at http://localhost:1313 +``` + +Most landing-page copy lives in [`data/content.yaml`](data/content.yaml) — edit text there, +not in the templates. See the [README](README.md#where-the-content-lives) for the full file map. + +## Development workflow + +1. Fork the repo and create a branch off `main`. +2. Make your change. Keep it focused — one logical change per PR. +3. Run the same two checks CI does (no server, no network): + + ```bash + hugo --gc --minify --panicOnWarning --baseURL "http://localhost/" # strict build + htmltest # link/anchor/image check + ``` +4. Update the README or other docs for any user-facing change. + +## Opening a pull request + +- Target the `main` branch and fill out the PR template. +- Link the issue your PR addresses (e.g. `Closes #123`). +- Make sure both checks above pass — CI will run the same ones. +- PRs require review before merging. + +By contributing, you agree that your contributions are licensed under the project's +[MIT License](LICENSE). Thanks again! 🙌 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..90bb930 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Vijit Singh + +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 07a6300..3092baa 100644 --- a/README.md +++ b/README.md @@ -107,4 +107,10 @@ automatically thereafter. To put it on a custom domain later: add `static/CNAME` containing the domain and set `baseURL` in `hugo.toml`. -— MIT, like everything else here. +## License & contributing + +Released under the **[MIT License](LICENSE)** — same as +[Pithead](https://github.com/p2pool-starter-stack/pithead) and +[RigForge](https://github.com/p2pool-starter-stack/rigforge). + +Contributions are welcome — see **[CONTRIBUTING.md](CONTRIBUTING.md)**.