Skip to content

Latest commit

 

History

History
76 lines (51 loc) · 4.54 KB

CONTRIBUTING.md

File metadata and controls

76 lines (51 loc) · 4.54 KB
Raw

Contributing to Monarch

If you have a question about Monarch (not a bug report) please post it to StackOverflow

Reporting bugs

  • Before opening a new issue, look for existing issues to avoid duplication. If the issue does not yet exist, create one.
    • Please post any relevant code samples, preferably a standalone script that reproduces your issue. Do not describe your issue in prose. Show your code.
    • If the bug involves an error, please post the stack trace.
    • Please post the version of Monarch and MongoDB that you're using.
    • Please write bug reports in JavaScript (ES5, ES6, etc) or TypeScript that runs in Node.js, not CoffeeScript, JSX, etc.

Requesting new features

  • Before opening a new issue, look for existing issues to avoid duplication. If the issue does not yet exist, create one.
  • Please describe a use case for it
  • Please include test cases if possible

Fixing bugs / Adding features

  • Before starting to write code, look for existing issues. That way you avoid working on something that might not be of interest or that has been addressed already in a different branch. You can create a new issue here..
    • The source of this project is written in TypeScript, not CoffeeScript or JavaScript. Please write your bug reports in JavaScript or TypeScript.
  • Fork the repo or for small documentation changes, navigate to the source on github and click the Edit button.
  • Follow the general coding style of the rest of the project:
    • 2 space tabs
    • no trailing whitespace
    • inline documentation for new methods, class members, etc.
    • 1 space between conditionals, no space before function parenthesis
      • if (..) {
      • for (..) {
      • while (..) {
      • function(err) {
  • Write tests and make sure they pass (tests are in the test directory).

Running the tests

  • Open a terminal and navigate to the root of the project
  • execute npm install to install the necessary dependencies
  • execute npm test to run the tests (we're using vitest)

Financial contributions

We also welcome financial contributions.

Credits

Contributors

Thank you to all the people who have already contributed to monarch! Monarch contributors

Backers

Thank you to all our backers! [Become a backer]

Monarch backers