faf199aca7
* feat: Add CONTRIBUTING.md * feat: Add CODE_OF_CONDUCT.md * feat: Add SECURITY.md * feat: Add LICENSE file * feat: Update README.md with improved documentation and project details * fix: Generalize README.md for forking workflow * fix: Correct Project Structure in README.md * fix: Correct Build Status badge URL in README.md * fix: Correct Build Status badge URL to point to original repository's live workflow * fix: Correct License badge URL to point to original repository Co-authored-by: Jane Alesi <ja@satware.ai>
2.5 KiB
Contributing to satware.ai Website
We welcome contributions to the satware.ai website! Your help is invaluable in making our documentation better. Please take a moment to review this document to understand how to contribute.
How to Contribute
-
Fork the Repository: Start by forking the
satwareAG-ironMike/satware.airepository to your GitHub account. -
Clone Your Fork: Clone your forked repository to your local machine:
git clone https://github.com/YOUR_USERNAME/satware.ai.git cd satware.ai -
Create a New Branch: Create a new branch for your feature or bug fix. Use a descriptive name (e.g.,
feature/add-new-page,fix/broken-link):git checkout -b feature/your-feature-name -
Set up Local Development: Follow the "Local Development" instructions in the
README.mdto get the website running locally../mkdocs.shThis will start a live-reloading server at
http://localhost:8000. -
Make Your Changes:
- Documentation: Most content is written in Markdown files located in the
docs/directory. - Styling: Custom styles are defined in
overrides/assets/css/custom.scss. Changes to this file will be automatically compiled todocs/assets/css/custom.cssby thescss_watcher.pyscript running in your Docker container. - Configuration: The main configuration is in
mkdocs.yml.
- Documentation: Most content is written in Markdown files located in the
-
Test Your Changes: Before submitting, ensure your changes work as expected by viewing them on your local development server.
-
Commit Your Changes: Write clear and concise commit messages.
git add . git commit -m "feat: Add new section on AI agents"(Consider using Conventional Commits for commit messages.)
-
Push to Your Fork:
git push origin feature/your-feature-name -
Create a Pull Request: Go to your forked repository on GitHub and create a new Pull Request targeting the
main-mkdocsbranch of thesatwareAG-ironMike/satware.airepository.- Provide a clear title and description of your changes.
- Reference any related issues.
Code of Conduct
Please note that this project is released with a Code of Conduct. By participating in this project, you agree to abide by its terms.
Security Policy
If you discover any security vulnerabilities, please report them responsibly by following our Security Policy.
Thank you for contributing!