Thank you for your interest in contributing! We welcome pull requests, bug reports, and suggestions to improve the MemMachine website.
-
Fork the repository
- Click the "Fork" button at the top right of the GitHub page.
-
Clone your fork
git clone https://github.com/MemMachine/memmachine.github.io.git
-
Create a new branch
git checkout -b my-feature-branch
-
Make your changes
- Edit content, layouts, styles, or configuration as needed.
-
Test locally
- Ensure you have Hugo (v0.148.2 or newer) and Node.js installed.
- Run
npm installif you change frontend assets. - Start the local server:
hugo server - Visit http://localhost:1313 to preview your changes.
-
Commit your changes
-
All commits must be signed. See Commit Signing Instructions for details.
-
Example:
git commit -sS -m "Describe your change"
-
-
Push to your fork
git push origin my-feature-branch
-
Open a pull request
- Go to the original repository and click "New pull request".
- Follow the Hugo documentation for content and theme changes.
- Write clear, descriptive commit messages.
- Keep pull requests focused and concise.
- Ensure your changes do not break the build or site navigation.
- For bug reports or feature requests, open an issue with details and steps to reproduce.
By contributing, you agree that your contributions will be licensed under the terms of the repository's LICENSE.