Skip to content

Latest commit

 

History

History
138 lines (98 loc) · 5.39 KB

CONTRIBUTING.md

File metadata and controls

138 lines (98 loc) · 5.39 KB
Raw

Contributing to atlas-sdk-go

Thanks for your interest in contributing to atlas-sdk-go, The following is a set of guidelines for contributing to this project. These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Note that atlas-sdk-go is an evolving project, so expect things to change over time as the team learns, listens and refines how we work with the community.

What should I know before I get started?

Code of Conduct

This project has adopted the MongoDB Code of Conduct. By participating, you are expected to uphold this code. If you see any violations of the above or have any other concerns or questions please contact us using the following email alias: [email protected].

How Can I Contribute?

Reporting Bugs or Suggesting Enhancements

Before reporting a bug or suggesting an enhancements please perform a cursory search to see if the bug or enhancement has already been suggested. If it has, add a :thumbsup: to indicate your interest in it, or comment if there is additional information you would like to add.

Bugs and enhancement suggestions are tracked as GitHub issues.

Simply create an issue on the project issue tracker and fill our the form.

Some additional advice:

  • Use a clear and descriptive title
  • Provide a step-by-step description of the issue This additional context helps the maintainers understand the enhancement from your perspective

Before Submitting A New Pull Request

Before creating a pull request consider opening a new issue first, please check this section on how we track issues for this project.

Autoclose stale issues and PRs

  • After 30 days of no activity (no comments or commits on an issue/PR) we automatically tag it as "stale" and add a message: This issue/PR has gone 30 days without any activity and meets the project's definition of "stale". This will be auto-closed if there is no new activity over the next 60 days. If the issue is still relevant and active, you can simply comment with a "bump" to keep it open, or add the label "not_stale". Thanks for keeping our repository healthy!
  • After 60 more days of no activity we automatically close the issue/PR.

Maintainer's Guide

Reviewers, please ensure that the CLA has been signed by referring to the contributors tool (internal link).

Development setup

Prerequisite Tools

Environment

  • Fork the repository.
  • Clone your forked repository locally.
  • We use Go Modules to manage dependencies, so you can develop outside of your $GOPATH.
  • We use golangci-lint to lint our code, you can install it locally via make tools.
  • For pull requests to be accepted, contributors must sign MongoDB CLA.

Building and testing

The following is a short list of commands that can be run in the root of the project directory:

  • Run make test to run all unit tests.
  • Run make lint to validate against our linting rules.

We provide a git pre-commit hook to format and check the code, to install it run make link-git-hooks

Repository structure

Repository contains following SDKs

  • auth: Atlas Auth SDK
  • admin: Atlas Admin SDK
  • tools: tooling used to generate Atlas Admin SDK. See ./tools for more information.
  • examples: SDK examples
  • internal: folder for hosting non user facing SDK methods and core helpers
  • mockadmin: Testify mocks generated with Mockery for API interfaces

VSCode debugging configuration

VSCode developers might use following debugging configuration for transformer and go debugging

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Debug Go App",
            "type": "go",
            "request": "launch",
            "mode": "debug",
            "program": "${file}"
        },
        {
            "type": "node",
            "request": "launch",
            "name": "Transform",
            "skipFiles": [
                "<node_internals>/**"
            ],
            "env": {
                "OPENAPI_FILE_NAME": "./openapi/atlas-api.yaml"
            },
            "args": ["./openapi/atlas-api.yaml"],
            "program": "${workspaceFolder}/tools/transformer/src/transform"
        }
    ]
}

Documentation

Documentation can be regenerated using make gen-docs

Folder Structure

  • ./docs - mostly manual documentation (only README.md and reference is generated)
  • ./docs/docs/- generated documentation for each SDK API

Changes in manual documentation

We recommend to create separate PR containing only documentation files each time manual documentation is changed. Documentation team will be assigned as reviewer automatically and will help with review of the PR.