CONTRIBUTING.md

November 22, 2024 ยท View on GitHub

By submitting a pull request, you represent that you have the right to license your contribution to the community, and agree by submitting the patch that your contributions are licensed under the Apache 2.0 license (see LICENSE).

Contributor Conduct

All contributors are expected to adhere to this project's Code of Conduct.

Development

Project Vision

For clarification behind certain API design decisions, or to get up to speed on the vision of the project, check out the API Design pages.

When adding a new file to the project, add the following heading to the top of the file:

//===----------------------------------------------------------------------===//
//
// This source file is part of the RediStack open source project
//
// Copyright (c) 2019-2020 Apple Inc. and the RediStack project authors
// Licensed under Apache License v2.0
//
// See LICENSE.txt for license information
// See CONTRIBUTORS.txt for the list of RediStack project authors
//
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//

When editing a file, ensure that the copyright header states the year 2019-<current year>.

Git Workflow

main is always the development branch.

For minor or patch SemVer changes, create a branch off of the tagged commit.

Environment Setup

It is highly recommended to use Docker to install Redis locally.

docker run -d -p 6379:6379 --name redis redis:5

Otherwise, install Redis directly on your machine from Redis.io.

Run CI checks locally

You can run the GitHub Actions workflows locally using act. For detailed steps on how to do this please see https://github.com/swiftlang/github-workflows?tab=readme-ov-file#running-workflows-locally.

Submitting a Pull Request

A great PR that is likely to be merged quickly is:

  1. Concise, with as few changes as needed to achieve the end result.
  2. Tested, ensuring that regressions aren't introduced now or in the future.
  3. Documented, adding API documentation as needed to cover new functions and properties.
  4. Accompanied by a great commit message