greg/mentat
1
0
Fork 0
Code Issues 294 Pull requests Packages Projects Releases 9 Wiki Activity

[doc] Update CONTRIBUTING.md to include test guidelines #110

New issue
Open
opened 2020-08-06 16:55:04 +00:00 by gburd · 0 comments
gburd commented 2020-08-06 16:55:04 +00:00 (Migrated from github.com)
Copy link

Which type of tests should/do we write?

  • docstring tests for functions that would benefit from examples in documentation
  • unit tests in same file -- prefer in a separate module in same file for decluttering, 14ecf92880
  • separate test file (tests/tests.rs) should be used more for integration tests

Let's get this into CONTRIBUTING.md.

Which type of tests should/do we write? * docstring tests for functions that would benefit from examples in documentation * unit tests in same file -- prefer in a separate module in same file for decluttering, https://github.com/mozilla/mentat/pull/211/commits/14ecf9288088f594f09c3702bb3e828c6dd97d63 * separate test file (tests/tests.rs) should be used more for integration tests Let's get this into `CONTRIBUTING.md`.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
master
dependabot/cargo/time-0.3.0
dependabot/cargo/env_logger-approx-0.9
dependabot/cargo/combine-approx-4.6
dependabot/cargo/rustc_version-approx-0.4
dependabot/add-v2-config-file
dependabot/cargo/rusqlite-approx-0.25
dependabot/cargo/tempfile-approx-3.2
gburd/replace-option-option
gh-pages
moz-pr/798
fluffyemily/store-management
fluffyemily/ios-docs
gh-pages-api-docs
fluffyemily/ios-ci
grisha/update-failure
buildtools-27.0.3-ndk-r15c-ndk-version-21-rust-stable-rust-beta
grisha/type_composition
fluffyemily/run-android-tests-travis
grisha/enumset
generic-automation-images
build-android-sdk
v0.8.2
grisha/syncable
entity-builder
grisha/tolstoy-concrete-error
doc-site-theme
fluffyemily/jekyll-docs
rnewman/renumber
grisha/sdkSample
grisha/androidBuild
grisha/gradlePublish
static_manager
rnewman/nn
grisha/updateGradle
fluffyemily/ffi-cache
fluffyemily/android-sdk-framework
rnewman/pull-keyword
rnewman/pull-nest
rnewman/arc
fluffyemily/ios-sdk-framework
fluffyemily/ffi_store
rnewman/basic-pull
rnewman/retract-schema
fluffyemily/query-builder
rnewman/tx-pred
fluffyemily/query-builder-take1
revert-ffi
rnewman/transact-watcher
rnewman/tx-log-observer
grisha/observers-sync
rnewman/edn-optimize
grisha/disable-ssl-add-issue-comments
rnewman/tutorial
grisha/tolstoy-reader
mozilla-grisha/tolstoy-reader
mozilla-eoger/tx-assertions
rnewman/type-hinting-nits
rnewman/tx-cardinality-one
rnewman/tx-assertions
rnewman/type-constraining-from-predicate
export_top_level_items
rnewman/simple-aggregates-2
fluffyemily/update_uuid
fluffyemily/cli
fluffemily/attributes
fluffyemily/tx-id-check
fluffyemily/type_tag_expansion
fluffyemily/expand_type_tags
rnewman/dedupe-args
rust
fluffyemily/read-from-file
fluffyemily/execute-edn
fluffyemily/start_mentat_in_cli
coverage
rnewman/bump-versions
rnewman/uuid
benchmarks-travis-test
rnewman/with
fluffyemily/not-not-join-rebased
fluffyemily/not-not-join
fluffyemily/parse-not-not-join
clojure
rnewman/no-ref
rnewman/parser-utils
rnewman/edn-printing
rnewman/parse-tx
rnewman/rebase-edn
database-explorer
other-crates
cli
bgrins-patch-1-1
bgrins-patch-1
rnewman/firefox
rnewman/unbound
rnewman/order-by-js
rnewman/generic-or
rnewman/joins
rnewman/fulltext-parse
transact-rewrite
rnewman/source-switcher
rnewman/negation
transact
sqlite-factory
rnewman/query
sqlite-schema
0.11.1
v0.11.0-3
v0.11.0-2
v0.11.0
v0.9.0
v0.10.0
v0.8.1
v0.8.0
0.3.1
v0.3.1
Labels
Clear labels   
A-build

   
A-cli

   
A-core

   
A-design

   
A-edn

   
A-ffi

   
A-query

   
A-sdk

   
A-sdk-android

   
A-sdk-ios

   
A-sync

   
A-transact

   
A-views

   
A-vocab

   
P-Android

   
P-desktop

   
P-iOS

   
bug

Something isn't working

  
correctness

   
dependencies

Pull requests that update a dependency file

  
dev-ergonomics

   
discussion

   
documentation

   
duplicate

This issue or pull request already exists

  
enhancement

New feature or request

  
enquiry

   
good first bug

   
good first issue

Good for newcomers

  
help wanted

Extra attention is needed

  
hygiene

   
in progress

   
invalid

This doesn't seem right

  
question

Further information is requested

  
ready

   
size

   
speed

   
wontfix

This will not be worked on

No labels
A-build
A-cli
A-core
A-design
A-edn
A-ffi
A-query
A-sdk
A-sdk-android
A-sdk-ios
A-sync
A-transact
A-views
A-vocab
P-Android
P-desktop
P-iOS
bug
correctness
dependencies
dev-ergonomics
discussion
documentation
duplicate
enhancement
enquiry
good first bug
good first issue
help wanted
hygiene
in progress
invalid
question
ready
size
speed
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: greg/mentat#110
No description provided.
Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?