Thanks for the help! We currently review PRs for **/*.
DocMQ is a Messaging Queue built for Document based databases such as Mongo or DocumentDB. We welcome all contributions to it. This file is designed to help you find your way around.
The repository has the bulk of its code in the src directory.
In the root of the repository, we have a few common files that are effectively "global". Some (eslint, prettier) affect formatting, while others (tsconfig) affect build scripts. If you're inside of a package and see it extending ../../something, it's relying on the common config.
💽 The development environment for this repository does not support Windows. To contribute from Windows you must use WSL.
- Fork this repository to your own GitHub account and then clone it to your local device. (
git remote add upstream [email protected]:jakobo/docmq.git😉). You can usegit clone --depth 1 --single-branch --branch main [email protected]:jakobo/docmq.git, discarding most of branches and history to clone it faster. - Ensure Node 14 is installed on your computer. (Check version with
node -v). We have Volta defined on the root package.json to help out. - Install the dependencies using pnpm with
pnpm install
If this didn't work for you as described, please open an issue.
This repo is set up to run pnpm test on commit. You can also run the command at any time to recheck your changes with AVA. We are not requiring new code to have corresponding tests at this time.
Written in AVA. Please see /test/*.spec.ts for examples. When writing driver tests, the driver suite expects at test time for t.context.driver to contain an instance of the driver being tested, t.context.insert to take a DocMQ document and insert it into the database, and t.context.dump to return all records in the database.
- By default, only the Loki driver tests will run. This is because not every architecture can run every DB
- Setting
process.env.MONGO_URIwill enable MongoDB tests using an external MongoDB instance. Please ensure it supports Replica Sets - Setting
process.env.POSTGRES_URLwill enable Postgres tests using an external Postgres instance
Until this ava issue is resolved, we work around this by selecting test/test.skip as a runtime evaluation.
These tests work with the docker image for mongodb, with the following caveats:
- After pulling, you must log into the instance and run
rs.initiate()to enable the replica set - You can then connect via Direct Connection with a URI such as
mongodb://127.0.0.1:27017/?replicaSet=rs0&directConnection=true
You may also use a free Atlas instance from MongoDB to test this driver, as all Atlas instances run replica sets by default.
End to End tests are accepted. Please use the LokiAdapter for any tests, as it does not mandate the external dependencies to be loaded.
Coming soon. As we learn what documentation people need, we'll undertake a docs project. It may be as simple as the README, or may use Github's inbuilt wiki.
If this is your first time committing to a large public repo, you could look through this neat tutorial: "How to Write a Git Commit Message"
For consistency, this repository uses Conventional Commits, making it easier to identify what changed, its impact, and if is a breaking change. You can see our supported types, though the majority of changes are likely to be feat, fix, or docs.
To help land your contribution, please make sure of the following:
- Remember to be concise in your Conventional Commit. These will eventually be automatically rolled up into an auto-generated CHANGELOG file
- If you modified anything in
src/:- You verified the transpiled TypeScript with
pnpm buildin the directory of whichever package you modified. This will also verify your CJS/ESM exports - Run
pnpm testto ensure all existing tests pass for that package, along with any new tests you would've written.
- You verified the transpiled TypeScript with
Thank you! 💕