Contributing to GitBase

Hello there! I'm Qiayue, the creator of GitBase. I'm thrilled that you're interested in contributing to our project. This guide is designed to help you understand how you can be a part of building and improving GitBase. Whether you're fixing bugs, adding new features, or improving documentation, your contributions are incredibly valuable and deeply appreciated. Let's work together to make GitBase even better!

First off, thank you for considering contributing to GitBase! It's people like you that make GitBase such a great tool.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please report unacceptable behavior to [[email protected]].

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for GitBase. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

Before Submitting A Bug Report

• Check the documentation for a list of common questions and problems.
• Ensure the bug was not already reported by searching on GitHub under Issues.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. Create an issue and provide the following information:

• Use a clear and descriptive title for the issue to identify the problem.
• Describe the exact steps which reproduce the problem in as many details as possible.
• Provide specific examples to demonstrate the steps.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for GitBase, including completely new features and minor improvements to existing functionality.

Before Submitting An Enhancement Suggestion

• Check if the enhancement has already been suggested.
• Determine which repository the enhancement should be suggested in.

How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. Create an issue and provide the following information:

• Use a clear and descriptive title for the issue to identify the suggestion.
• Provide a step-by-step description of the suggested enhancement in as many details as possible.
• Provide specific examples to demonstrate the steps.

Your First Code Contribution

Unsure where to begin contributing to GitBase? You can start by looking through these beginner and help-wanted issues:

• Beginner issues - issues which should only require a few lines of code, and a test or two.
• Help wanted issues - issues which should be a bit more involved than beginner issues.

Pull Requests

The process described here has several goals:

• Maintain GitBase's quality
• Fix problems that are important to users
• Engage the community in working toward the best possible GitBase
• Enable a sustainable system for GitBase's maintainers to review contributions

Please follow these steps to have your contribution considered by the maintainers:

1. Follow all instructions in the template
2. Follow the styleguides
3. After you submit your pull request, verify that all status checks are passing

Styleguides

Git Commit Messages

• Use the present tense ("Add feature" not "Added feature")
• Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
• Limit the first line to 72 characters or less
• Reference issues and pull requests liberally after the first line

JavaScript Styleguide

All JavaScript must adhere to JavaScript Standard Style.

Documentation Styleguide

• Use Markdown.

License

By contributing, you agree that your contributions will be licensed under its MIT License.

Questions?

Don't hesitate to contact the project maintainers if you have any questions or need further clarification on how to contribute.

Thank you for your interest in contributing to GitBase! We look forward to your contributions and working together to make GitBase even better.