Skip to content

Latest commit

 

History

History
113 lines (69 loc) · 6.39 KB

contribution-guide.md

File metadata and controls

113 lines (69 loc) · 6.39 KB
tags
todo, good-first-task

Contribution Guide

Foam is open to contributions of any kind, including but not limited to code, documentation, ideas, and feedback. This guide aims to help guide new and seasoned contributors getting around the Foam codebase. For a comprehensive guide about contributing to open-source projects in general, see here.

Getting Up To Speed

Before you start contributing we recommend that you read the following links:

  • [principles] - This document describes the guiding principles behind Foam.
  • [code-of-conduct] - Rules we hope every contributor aims to follow, allowing everyone to participate in our community!

Diving In

We understand that diving in an unfamiliar codebase may seem scary, to make it easier for new contributors we provide some resources:

You can also see existing issues and help out! Finally, the easiest way to help, is to use it and provide feedback by submitting issues or participating in the Foam Community Discord!

Contributing

If you're interested in contributing, this short guide will help you get things set up locally (assuming node.js >= v16 and yarn are already installed on your system).

  1. Fork the project to your Github account by clicking the "Fork" button on the top right hand corner of the project's home repository page.

  2. Clone your newly forked repo locally:

    git clone https://github.com/your_username/foam.git

  3. Install the necessary dependencies by running this command from the root of the cloned repository:

    yarn install

  4. From the repository root, run the command:

    yarn build

You should now be ready to start working!

Structure of the project

Foam code and documentation live in the monorepo at foambubble/foam.

Exceptions to the monorepo are:

This project uses Yarn workspaces.

Originally Foam had:

To improve DX we have moved the foam-core module into packages/foam-vscode/src/core, but from a development point of view it's useful to think of the foam-vscode/src/core "submodule" as something that might be extracted in the future.

For all intents and purposes this means two things:

  1. nothing in foam-vscode/src/core should depend on files outside of this directory
  2. code in foam-vscode/src/core should NOT depend on vscode library

We have kept the yarn workspace for the time being as we might use it to pull out foam-core in the future, or we might need it for other packages that the VS Code plugin could depend upon (e.g. currently the graph visualization is inside the module, but it might be pulled out if its complexity increases).

Testing

Code needs to come with tests. We use the following convention in Foam:

  • *.test.ts are unit tests
  • *.spec.ts are integration tests

Tests live alongside the code in src.

The VS Code Extension

This guide assumes you read the previous instructions and you're set up to work on Foam.

  1. Now we'll use the launch configuration defined at .vscode/launch.json to start a new extension host of VS Code. Open the "Run and Debug" Activity (the icon with the bug on the far left) and select "Run VSCode Extension" in the pop-up menu. Now hit F5 or click the green arrow "play" button to fire up a new copy of VS Code with your extension installed.

  2. In the new extension host of VS Code that launched, open a Foam workspace (e.g. your personal one, or a test-specific one created from foam-template). This is strictly not necessary, but the extension won't auto-run unless it's in a workspace with a .vscode/foam.json file.

  3. Test a command to make sure it's working as expected. Open the Command Palette (Ctrl/Cmd + Shift + P) and select "Foam: Update Markdown Reference List". If you see no errors, it's good to go!

Submitting a Pull Request (PR)

After you have made your changes to your copy of the project, it is time to try and merge those changes into the public community project.

  1. Return to the project's home repository page.
  2. Github should show you an button called "Compare & pull request" linking your forked repository to the community repository.
  3. Click that button and confirm that your repository is going to be merged into the community repository. See this guide for more specifics.
  4. Add as many relevant details to the PR message to make it clear to the project maintainers and other members of the community what you have accomplished with your new changes. Link to any issues the changes are related to.
  5. Your PR will then need to be reviewed and accepted by the other members of the community. Any discussion about the changes will occur in your PR thread.
  6. Once reviewed and accept you can complete the merge request!
  7. Finally rest and watch the sun rise on a grateful universe... Or start tackling the other open issues ;)

Feel free to modify and submit a PR if this guide is out-of-date or contains errors!