Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

34 lines (23 loc) · 1.8 KB

Contribution Guidelines

Installation and Setup

Before you start contributing, please make sure your local environment is properly set up and meets the following requirements:

  • Node version 14.x or above
  • Required dependencies and libraries installed with the correct versions

Contribution Process

  1. Fork the main branch of this repository to your GitHub account.
  2. Create a new branch for your contributions. It is recommended to use a descriptive name for the branch.
  3. Make your modifications and work on the branch.
  4. If you add new content, import your additions in the src/index.ts file and write test cases for your additions in the test directory.
  5. Commit your changes. Make sure your commit message is clear, concise, and follows the code submission guidelines (refer to the guidelines below).
  6. Submit a Pull Request to the main branch of the original repository.
  7. Wait for code review and feedback. Make any necessary modifications and adjustments as required.
  8. Once your contributions are approved, they will be merged into the main branch.

Version Control and Branch Management

  • The main branch is used for stable releases.
  • The gh-pages branch is used for publishing project documentation.

Submission Requirements

  • Please follow the project's code style guide and naming conventions.
  • Please follow the project's commenting guidelines to ensure that others can understand and maintain your code.
  • Ensure that your changes do not affect existing functionality and pass the relevant test cases.

Community Code of Conduct

We expect all participants to adhere to our community code of conduct. Please maintain a friendly, respectful, and collaborative attitude in all communication and interactions. Report any instances of inappropriate behavior promptly to the project maintainers.