Skip to content

Commit

Permalink
[#3727] Update contribution doc
Browse files Browse the repository at this point in the history
### What changes were proposed in this pull request?

This pull request updates the `CONTRIBUTING.md` file with new guidelines
and detailed sections. Key changes include:

- Added a detailed "Table of contents" section for easy navigation.
- Introduced new subsections: "Development Setup," "Project Overview and
Policies," "The Review Process."
- Provided clearer instructions for forking the repository and setting
up the development environment.
- Enhanced the guidelines for reporting bugs, suggesting enhancements,
and working on issues.
- Improved the contribution process with detailed steps for creating
pull requests and the review process.
- Updated testing and coding standards sections with more detailed
instructions.
- Added links to relevant documents and resources for better guidance.

### Why are the changes needed?

These changes are needed to provide clearer and more comprehensive
guidelines for contributors. This helps to:

1. Improve the contributor experience by providing detailed instructions
and resources.
2. Ensure consistency and quality in contributions by outlining coding
standards and review processes.
3. Facilitate easier onboarding for new contributors by providing a
structured and detailed contribution guide.

Fix: # (issue) <!-- If this PR fixes an issue, replace the parentheses
with the issue number. If not, you can remove this line. -->

### Does this PR introduce _any_ user-facing change?

No, this PR does not introduce any user-facing changes. It updates the
contribution guidelines to help contributors.

### How was this patch tested?

This patch was reviewed for accuracy and clarity. Since it involves
documentation, no code tests were necessary. However, the instructions
provided in the document were verified to ensure they are correct and
up-to-date.

---------

Co-authored-by: LanceLin <lancehsun@gmail.com>
  • Loading branch information
LanceHsun and LanceLin authored Jun 5, 2024
1 parent ec7e6f3 commit b902fd4
Showing 1 changed file with 29 additions and 8 deletions.
37 changes: 29 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,19 @@ Before you get started, please read and follow these guidelines to ensure a smoo

- [Getting Started](#getting-started)
- [Fork the Repository](#fork-the-repository)
- [Development Setup](#development-setup)
- [Project Overview and Policies](#project-overview-and-policies)
- [Project Overview](#project-overview)
- [Management Policies](#management-policies)
- [Future Development Directions](#future-development-directions)
- [Contribution Guidelines](#contribution-guidelines)
- [Code of Conduct](#code-of-conduct)
- [Reporting Bugs](#reporting-bugs)
- [Suggesting Enhancements](#suggesting-enhancements)
- [Good First Issues](#good-first-issues)
- [Working on Issues](#working-on-issues)
- [Creating Pull Requests](#creating-pull-requests)
- [Development Setup](#development-setup)
- [The Review Process](#the-review-process)
- [Testing](#testing)
- [Coding Standards](#coding-standards)
- [Community and Communication](#community-and-communication)
Expand All @@ -37,7 +42,25 @@ git clone https://github.com/datastrato/gravitino.git
cd gravitino
```

Now you are ready to start making contributions.
### Development Setup

Once you have cloned the [GitHub repository](https://github.com/datastrato/gravitino), see [how to build](/docs/how-to-build.md) for instructions on how to build, or you can use the provided docker images at [Datastrato's DockerHub repository](https://hub.docker.com/u/datastrato).

To stop and start a local Gravitino server via `bin/gravitino.sh start` and `bin/gravitino.sh stop` in a Gravitino distribution, see [how to build](/docs/how-to-build.md) for more instructions.

## Project Overview and Policies

### Project Overview

For an overview of the project, see [README.md](README.md).

### Management Policies

For project management policies, refer to [GOVERNANCE.md](GOVERNANCE.md).

### Future Development Directions

For future development directions, refer to the [ROADMAP.md](ROADMAP.md) document.

## Contribution guidelines

Expand All @@ -47,7 +70,7 @@ Please read and follow the [Code of Conduct](CODE_OF_CONDUCT.md). Gravitino prov

### Reporting bugs

If you find a bug in Gravitino, please open an issue on GitHub. Be sure to include as much detail as possible, such as a clear description, steps to reproduce, and your environment. Please follow the template provided.
If you find a bug in Gravitino, please open an issue on GitHub. Be sure to include as much detail as possible, such as a clear description, steps to reproduce, and your environment. Please follow the template provided. If you encounter a security issue, please refer to [SECURITY.md](SECURITY.md).

### Suggesting enhancements

Expand All @@ -63,7 +86,7 @@ Check out the list of open issues and find one that interests you. You can also

## Creating pull requests

Create a new branch from ``main`` for your changes:
Create a new branch from `main` for your changes:

```bash
git checkout -b your-branch-name
Expand All @@ -83,11 +106,9 @@ git push your-branch-name

After you have pushed your changes, create a pull request (PR) in the Gravitino repository. Be sure to provide a detailed description of your changes, reference any related issues and please follow the template provided. Gravitino's maintainers evaluate pull requests, offer feedback, and assist in merging project changes.

## Development setup

Once you have cloned the [GitHub repository](https://github.com/datastrato/gravitino), see [how to build](/docs/how-to-build.md) for instructions on how to build, or you can use the provided docker images at [Datastrato's DockerHub repository](https://hub.docker.com/u/datastrato).
### The Review Process

To stop and start a local Gravitino server via ``bin/gravitino.sh start`` and ``bin/gravitino.sh stop`` in a Gravitino distribution, see [how to build](/docs/how-to-build.md) for more instructions.
For details on the review process, please refer to [MAINTAINERS.md](MAINTAINERS.md).

## Testing

Expand Down

0 comments on commit b902fd4

Please sign in to comment.