Thank you for your interest in contributing to gatsby-source-airtable-next.
Both code and other types of contributions are welcome.
- Read our Code of Conduct to keep our community approachable and respectable.
- Read the README to get an overview of the project.
- Browse the issues and discussions already taking place to familiarize yourself with the state of the project.
You may either solve an exciting issue, or create a new issue.
Either way, make sure to outline your plan of action and get some feedback before spending too much time on your solution.
If you are new to open source code contributions, here are some links to get you started:
- Fork this repository
- Clone the fork to your local machine:
git clone /[email protected]:davidpaulsson/gatsby-source-airtable-next.git - Move into repo folder:
cd gatsby-source-airtable-next - Install packages:
yarn install
The project uses yarn workspace to host the plugin and demo codes in one repository.
When installing dependencies, make sure to include workspace plugin or workspace demo to the command so that dependencies are added to the correct workspace: yarn workspace plugin add lodash.
Important note from the yarn workspace docs:
Be careful when publishing packages in a workspace. If you are preparing your next release and you decided to use a new dependency but forgot to declare it in the package.json file, your tests might still pass locally if another package already downloaded that dependency into the workspace root. However, it will be broken for consumers that pull it from a registry, since the dependency list is now incomplete so they have no way to download the new dependency. Currently, there is no way to throw a warning in this scenario.
Run demo: yarn develop
[TODO] Project structure [TODO] Style guide
[TODO] Add a test and document
When finished with the changes, create a pull request, also known as a PR.
[TODO] How to name the PR [TODO] Only squash merge allowed
The project uses conventional commits and semantic versioning to automate releases by utalizing the semantic-release project.
If you have any questions, feedback or suggestions head on over to discussions.
If you find a bug please open an issue and/or create a pull request to fix it.