mirror of
https://github.com/foambubble/foam.git
synced 2026-04-24 03:01:01 -04:00
1.8 KiB
1.8 KiB
Contribution Guide
[todo] [good-first-task] This contribution guide itself could be improved 😅
Foam is open to contributions of any kind, including but not limited to code, documentation, ideas and feedback. Here's how to get started on contributing to Foam:
- Use Foam for yourself, figure out what could be improved.
- Check out [roadmap] to see what's already in the plans. I have thoughts about how to implement some of these, but open to ideas and code contributions!
- Read about our [principles] to understand Foam's philosophy and direction
- Read and act in accordance of our [code-of-conduct].
- Feel free to open GitHub issues to give me feedback and ideas for new features.
- Foam code and documentation live in the monorepo at foambubble/foam
- /docs: documentation and [recipes]
- /packages/foam-vscode: the core VSCode plugin
- /packages/foam-workspace-manager: Foam workspace automations
- Exceptions to the monorepo are:
- The starter template at foambubble/foam-template
- All other [recommended-extensions] live in their respective GitHub repos.