Skip to content

[docs] Docs #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Edgardo-Ramirez-Canales wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[docs] Docs #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,19 @@ mdbook serve --open
Dual-licensed under [MIT](LICENSE-MIT) and [Apache 2.0](LICENSE-APACHE).

Copyright (c) 2025-2026 Joshua J. Bouw and Unicity Labs.

## Contributing

We welcome contributions to the Astrid project! To get started, please follow these guidelines:

1. **Create an Issue**: Before submitting a pull request, please create an issue to discuss your proposed changes. This helps us understand the context and ensures that your contribution aligns with the project goals.

2. **Fork the Repository**: Fork the repository to your own GitHub account and clone it to your local machine.

3. **Make Your Changes**: Create a new branch for your changes and make your modifications. Ensure that your code adheres to the project's coding standards.

4. **Submit a Pull Request**: Once you're satisfied with your changes, push your branch to your forked repository and submit a pull request. Make sure to reference the issue you created earlier by including `Closes #<issue_number>` in your pull request description.

5. **Follow the Review Process**: Your pull request will be reviewed by the maintainers. Be open to feedback and willing to make adjustments as needed.

Thank you for contributing to Astrid!