|
1 | | -# Contributing to my Portfolio |
| 1 | +# Contributing to this template |
2 | 2 |
|
3 | | -If you want to change something major make a suggestion via the [issues tab](https://github.com/kiyarose/Portf/issues). |
4 | | -Otherwise you are free to make a fork of this project and make a PR to a new branch and I will review it for implementation. |
5 | | -If you have any questions use the contact form on the website. |
| 3 | +This repository is a community-friendly template. If you find a bug or want to propose improvements: |
| 4 | + |
| 5 | +- Open an issue in the template's repository (or your fork) describing the change. |
| 6 | +- Send a PR against `main` with a focused change and clear description/screenshots for visual changes. |
| 7 | + |
| 8 | +If you've forked this template to make a personal portfolio, treat your fork as the canonical source for your site and maintain your own issues/PRs there. |
| 9 | + |
| 10 | +--- |
| 11 | + |
| 12 | +Below are suggestions and quick checks to help you convert this repo into your own project, or to accept contributions to the template itself. |
| 13 | + |
| 14 | +## For people using this template (your fork) |
| 15 | + |
| 16 | +- Keep your fork as the canonical source for your personal site. Maintain issues/PRs on your fork and update the following files early in your edit process: |
| 17 | + - `README.md` — update site name, short description, and deploy steps. |
| 18 | + - `LICENSE` — replace the copyright line (see `LICENSE.example` for guidance). |
| 19 | + - Important: this template includes a BSD-3-Clause `LICENSE` that must be preserved as-is in the source |
| 20 | + when redistributing or publishing derived works (see `LICENSE.example` for how to add your own copyright |
| 21 | + attribution without removing the original line). |
| 22 | + - `public/index.html` and `src/data/*` — replace demo content with your personal content. |
| 23 | + |
| 24 | +- If you plan to accept outside contributions on your fork, add a `CODE_OF_CONDUCT.md`, a `PULL_REQUEST_TEMPLATE.md`, and/or an `ISSUE_TEMPLATE/` directory so contributors have clear expectations. |
| 25 | + |
| 26 | +## For contributors to this template repository |
| 27 | + |
| 28 | +- Keep changes small and focused. This repo is used as a starting point for many forks, so API and config stability matters. |
| 29 | +- Before submitting a PR, run the normal checks: |
| 30 | + - `npm run lint` |
| 31 | + - `npm run build` |
| 32 | + - Run tests where present (`npm test` / Playwright checks) |
| 33 | + - Update/add documentation or inline comments for new features. |
| 34 | + |
| 35 | +## Customizing contribution policies |
| 36 | + |
| 37 | +You may want a different collaboration model depending on how public you want the project to be: |
| 38 | + |
| 39 | +- Public template (default): allow issues and PRs from the community, protect `main` with branch protections, and enable CI checks. |
| 40 | +- Private/managed template: restrict PRs to maintainers, require issue approval or design review before merging. |
| 41 | + |
| 42 | +Suggested repo files to add if you change the model: |
| 43 | + |
| 44 | +- `CODE_OF_CONDUCT.md` — sets community expectations. |
| 45 | +- `PULL_REQUEST_TEMPLATE.md` — helps contributors include tests, screenshots, or migration notes. |
| 46 | +- `CODEOWNERS` — assigns reviewers automatically. |
| 47 | + |
| 48 | +## Security and license reminders |
| 49 | + |
| 50 | +- This repo ships a default `LICENSE` (BSD 3-Clause). If you change the license for your fork, update the `LICENSE` file and the `package.json` `license` field. |
| 51 | +- Preserve existing license headers and notices when redistributing or modifying upstream code. See `LICENSE.example` for guidance on common license choices and how to update attribution. |
| 52 | + - Preserve existing BSD-3-Clause headers and notices (including the 2025 Kiya Rose attribution) when redistributing or modifying upstream code. `LICENSE.example` shows how to add your own copyright line in |
| 53 | + addition to the original notice so legal attribution is not lost. |
| 54 | +- If you add new developer tools (linters, scanners, or CI steps) that require secrets or external services, document how to configure them in the `README.md` and `SECURITY.md` so downstream users can replicate or opt out. |
| 55 | + |
| 56 | +--- |
| 57 | + |
| 58 | +If you want, I can also add example `PULL_REQUEST_TEMPLATE.md` and `CODE_OF_CONDUCT.md` files tailored for a template repository. |
| 59 | +# Contributing to this template |
| 60 | + |
| 61 | +This repository is a community-friendly template. If you find a bug or want to propose improvements: |
| 62 | + |
| 63 | +- Open an issue in the template's repository (or your fork) describing the change. |
| 64 | +- Send a PR against `main` with a focused change and clear description/screenshots for visual changes. |
| 65 | + |
| 66 | +If you've forked this template to make a personal portfolio, treat your fork as the canonical source for your site and maintain your own issues/PRs there. |
0 commit comments