Skip to content

Latest commit

 

History

History
55 lines (42 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

55 lines (42 loc) · 2.51 KB
Raw

Contribution Guidelines

Welcome to Awesome-Text2GQL! We're thrilled that you'd like to contribute. Your help is essential for making it better.

Getting Started

Before you start contributing, please make sure you have read and understood our Code of Conduct.

Fork the Repository

First, fork the Awesome-Text2GQL repository to your own GitHub account. This will create a copy of the project under your account.

Clone Your Own Repository

git clone https://github.com/`your-github-name`/Awesome-Text2GQL.git

Navigate to the Project Directory 📁

cd Awesome-Text2GQL

Create a new branch for your feature or bug fix:

 git checkout -b feature-branch

feature-branch is the name of the branch where you will be making your changes. You can name this whatever you want.

Make your changes and commit them:

git add .
git commit -m "Description of your changes"

Push your changes to your fork:

git push origin feature-branch

Finally Click on Compare & Pull request to contribute on this repository.

The Flow After You Create the Pull Request

After you create the pull request, a member of the TuGraph team will review your changes and provide feedback. Once satisfied, they will merge your pull request.

The Flow After Your Pull Request is Merged

In default, the pull request is merged into the master branch of Awesome-Text2GQL.

Feature Developing

If you want to develop a new feature, you should create a discussion first. If your idea is accepted, you can create a new issue and start to develop your feature and we will create a feature branch for you. After you finish your feature, you can create a pull request to merge your feature branch into Awesome-Text2GQL master branch. The flow like below.

  1. Create a discussion
  2. Create a new issue
  3. Create a new feature branch on Awesome-Text2GQL for your feature
  4. Make your changes and commit them
  5. Push your changes to your fork
  6. Create a pull request to merge your code into master branch
  7. After your pull request is reviewed and approved by a TuGraph team member, we will merge your feature branch into master branch