|
| 1 | +# Contributing to MemMachine Website |
| 2 | + |
| 3 | +Thank you for your interest in contributing! We welcome pull requests, bug reports, and suggestions to improve the MemMachine website. |
| 4 | + |
| 5 | +## How to Contribute |
| 6 | + |
| 7 | +1. **Fork the repository** |
| 8 | + |
| 9 | + - Click the "Fork" button at the top right of the GitHub page. |
| 10 | + |
| 11 | +2. **Clone your fork** |
| 12 | + |
| 13 | + - `git clone https://github.com/MemMachine/memmachine.github.io.git` |
| 14 | + |
| 15 | +3. **Create a new branch** |
| 16 | + |
| 17 | + - `git checkout -b my-feature-branch` |
| 18 | + |
| 19 | +4. **Make your changes** |
| 20 | + |
| 21 | + - Edit content, layouts, styles, or configuration as needed. |
| 22 | + |
| 23 | +5. **Test locally** |
| 24 | + |
| 25 | + - Ensure you have [Hugo](https://gohugo.io/getting-started/installing/) (v0.148.2 or newer) and Node.js installed. |
| 26 | + - Run `npm install` if you change frontend assets. |
| 27 | + - Start the local server: `hugo server` |
| 28 | + - Visit [http://localhost:1313](http://localhost:1313) to preview your changes. |
| 29 | + |
| 30 | +6. **Commit your changes** |
| 31 | + |
| 32 | + - All commits must be signed. See [Commit Signing Instructions](https://github.com/microsoft/vscode/wiki/Commit-Signing) for details. |
| 33 | + - Example: |
| 34 | + |
| 35 | + `git commit -sS -m "Describe your change"` |
| 36 | + |
| 37 | +7. **Push to your fork** |
| 38 | + |
| 39 | + - `git push origin my-feature-branch` |
| 40 | + |
| 41 | +8. **Open a pull request** |
| 42 | + |
| 43 | + - Go to the original repository and click "New pull request". |
| 44 | + |
| 45 | +## Guidelines |
| 46 | + |
| 47 | +- Follow the [Hugo documentation](https://gohugo.io/documentation/) for content and theme changes. |
| 48 | +- Write clear, descriptive commit messages. |
| 49 | +- Keep pull requests focused and concise. |
| 50 | +- Ensure your changes do not break the build or site navigation. |
| 51 | +- For bug reports or feature requests, open an issue with details and steps to reproduce. |
| 52 | + |
| 53 | +## License |
| 54 | + |
| 55 | +By contributing, you agree that your contributions will be licensed under the terms of the repository's [LICENSE](./LICENSE). |
0 commit comments