Skip to content

Latest commit

 

History

History
65 lines (39 loc) · 3.52 KB

CONTRIBUTING.md

File metadata and controls

65 lines (39 loc) · 3.52 KB
Raw

How to Contribute

Thank you for your interest in contributing to the dCloud Topology Builder Go Client project! To ensure smooth collaboration and effective development, please review the following guidelines. By following these guidelines, you demonstrate respect for the time and efforts of the project's contributors. In return, they will reciprocate by addressing your issues, evaluating changes, and assisting with your pull requests. We strive to review incoming issues and pull requests within 10 days. Any lingering issues or pull requests inactive for 60 days will be closed.

Please note that all interactions within the project are subject to our Code of Conduct. This applies to creating issues or pull requests, commenting on them, as well as any real-time discussions in platforms like Slack, Discord, etc.

Table Of Contents

Reporting Issues

Before reporting a new issue, please search our issues list to ensure that it hasn't already been reported or fixed.

When creating a new issue, include a clear title, a detailed description, relevant information, and if possible, a test case.

If you discover a security vulnerability, please refrain from reporting it through GitHub. Instead, follow the security procedures outlined in SECURITY.md.

Development

Setting up the Development Environment

To set up your development environment for the dCloud Topology Builder Go Client, follow the instructions below:

  1. Clone the repository: git clone https://github.com/cisco-open/dcloud-tb-go-client.git
  2. Navigate to the project directory: dcloud-tb-go-client
  3. Install the necessary dependencies: https://go.dev/doc/install

Building the dCloud Topology Builder Go Client

To build the dCloud Topology Builder Go Client, execute the following steps:

  1. Install Go
  2. Execute the following from the root of the repository: go build ./tbclient

Running Tests

To run the tests for the dCloud Topology Builder Go Client, use the following command:

Execute the following from the root of the repository: go test ./tbclient

Sending Pull Requests

Before submitting a new pull request, please check existing pull requests and issues to ensure that your proposed changes or fixes haven't been discussed in the past or already implemented but not released.

When submitting a pull request, include tests for any affected behavior. As we follow semantic versioning, breaking changes may be reserved for the next major version release.

Other Ways to Contribute

We welcome contributions beyond code. Here are some ways you can contribute to the dCloud Topology Builder Go Client project:

  • Help triage and respond to open issues, providing troubleshooting assistance and suggesting fixes.
  • Review existing pull requests and test patches against real applications that use the dCloud Topology Builder Go Client.
  • Write new tests or add missing test cases to existing tests.

Thank you for your interest in contributing to the dCloud Topology Builder Go Client project!

❤️