diff --git a/README.md b/README.md index b1a4618..31f8a8c 100644 --- a/README.md +++ b/README.md @@ -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 #` 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!