Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (36 loc) · 3.03 KB

CONTRIBUTING.md

File metadata and controls

60 lines (36 loc) · 3.03 KB

Contribution Guide

Welcome to the contribution guide! I appreciate your interest in contributing to github-AutoResponse project. This guide will provide you with the necessary information and guidelines to make your contributions valuable and effective.

1. Getting started

Contributions can come in various forms, including bug fixes, refactoring the code, documentation improvements, and more. Here are some ways you can contribute to the repository:

  • Fix bugs and address issues.
  • Refactor code for better maintainability.
  • Improve the documentation.

If you're unsure about what to work on, you can check the repository's issue tracker for any open issues.

2. Code Style and Guidelines

To maintain a consistent codebase, this project follow certain code style and guidelines. Please adhere to the following conventions when contributing code:

  • Follow the code standard and writing style from ESLint config.
  • Use camelcase for variable, function, etc.
  • Write clear and concise comments when necessary (will remove after merging).

3. Running the Linter

This repository have a linter set up for the project to ensure consistent code style and catch potential issues. Before opening a pull request, please run the following command to execute the linter and fix any reported issues:

npm run lint

Make sure the linter passes without any errors or warnings before proceeding with your pull request. This step ensures that the codebase remains clean and consistent.

4. Using Conventional Commits

To have a consistent commit message format across the repository, we follow the Conventional Commits specification. Please use the following format for your commit messages:

<type>[optional scope]: <description>

Here's an example of a conventional commit message:

feat(core): add issue_comment.created event

For more information about the Conventional Commits specification, you can refer to conventionalcommits.org.

5. Avoiding Copyright Infringement

When contributing code or any other content, it's important to ensure that your contributions are your own original creation and do not violate any copyright laws or infringe upon the intellectual property rights of others. By contributing to this repository, you agree to the following:

  • You warrant that the contribution is your original work.
  • You agree to grant the repository maintainers and users a license to use your contributions under the repository's designated license. LICENSE

Please refrain from including any code, documentation, or other content in your contributions that may have been copied or derived from copyrighted sources without the necessary permissions or licenses.

6. LICENSE

By contributing to this repository, you agree that your contributions will be licensed under the same license as the repository itself. Please refer to the repository's LICENSE file for more details.