Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
129 lines (91 loc) · 4.85 KB

CONTRIBUTING.md

File metadata and controls

129 lines (91 loc) · 4.85 KB
Raw

Contributing

Everyone is welcome to contribute to GoDaddy's Open Source Software. Contributing doesn't just mean submitting pull requests. To get involved you can report or triage bugs and participate in discussions on the evolution of each project.

This document is for contributors outside of GoDaddy; for internal contributors, go to the Maintainers Guide.

Answering Questions

One of the most important and immediate ways you can support this project is to answer questions on GitHub. Whether you're helping a newcomer understand a feature or troubleshooting an edge case with a seasoned developer, your knowledge and experience can go a long way to help others.

Reporting Bugs

Do not report potential security vulnerabilities here. Refer to SECURITY.md for more details about the process of reporting security vulnerabilities.

Before submitting a ticket, please be sure to have a simple replication of the behavior. If the issue is isolated to one of the dependencies of this project, please create a GitHub issue in that project.

Submit a ticket for your issue, assuming one does not already exist:

  • Create it on our Issue Tracker
  • Clearly describe the issue by following the template layout
    • Make sure to include steps to reproduce the bug.
    • A reproducible test could be helpful in solving the bug.
    • Describe the environment that (re)produced the problem.

For a bug to be actionable, it needs to be reproducible. If you or contributors can't reproduce the bug, try to figure out why. Please take care to stay involved in discussions around solving the problem.

Triaging bugs or contributing code

If you're triaging a bug, try to reduce it. Once a bug can be reproduced, reduce it to the smallest amount of code possible. Reasoning about a sample or unit test that reproduces a bug in just a few lines of code is easier than reasoning about a longer sample.

From a practical perspective, contributions are as simple as:

  • Forking the repository on GitHub.
  • Making changes to your forked repository.
  • When committing, reference your issue (if present) and include a note about the fix.
  • If possible, and if applicable, please also add/update unit tests for your changes.
  • Push the changes to your fork and submit a pull request to the main branch of the project's repository.

If you are interested in making a large change and feel unsure about its overall effect, please make sure to first discuss the change and reach a consensus with core contributors. Then ask about the best way to go about making the change.

Development Setup

All source code lives under rust/. Install Rust if you haven't already.

cd rust

# Build
cargo build

# Run tests
cargo test

# Lint (must pass with no warnings)
cargo clippy -- -D warnings

# Format
cargo fmt

# Type-check only (fast)
cargo check

# Regenerate the embedded API catalog (needs access to GoDaddy's internal spec repos)
cargo run -p generate-api-catalog

If the CI "API catalog drift" check fails, see Updating embedded API specs.

Adding a pre-release command, or wondering why one is hidden behind the default build? See docs/feature-flags.md.

Code Review

Any open source project relies heavily on code review to improve software quality:

All significant changes, by all developers, must be reviewed before they are committed to the repository. Code reviews are conducted on GitHub through comments on pull requests or commits. The developer responsible for a code change is also responsible for making all necessary review-related changes.

Sometimes code reviews will take longer than you would hope for, especially for larger features. Here are some accepted ways to speed up review times for your patches:

  • Review other people's changes. If you help out, everybody will be more willing to do the same for you. Good will is our currency.
  • Split your change into multiple smaller changes. The smaller your change, the higher the probability that somebody will take a quick look at it.
  • Remember that you're asking for valuable time from other professional developers.

Note that anyone is welcome to review and give feedback on a change, but only people with commit access to the repository can approve it.

Attribution of Changes

When contributors submit a change to this project, after that change is approved, other developers with commit access may commit it for the author. When doing so, it is important to retain correct attribution of the contribution. Generally speaking, Git handles attribution automatically.

Additional Resources