Skip to content
This repository was archived by the owner on Aug 18, 2026. It is now read-only.

CONTRIBUTION.md

Latest commit

 

History

History
65 lines (42 loc) · 2.34 KB

CONTRIBUTION.md

File metadata and controls

65 lines (42 loc) · 2.34 KB
Raw

Contribution Workflow

  1. Fork the Repository

    • Click the “Fork” button at the top of this repo.
    • Clone your fork to your local machine.

  2. Create a New Branch

    • Branch off from main.
    • Name your branch using your GitHub username and a brief summary of the issue or feature.
      • Example: Anny0nn-new_feature

  3. Make Your Changes

    • Add or update code, tests, and documentation as needed.
    • If you introduce a new feature or fix a bug, please ensure you cover it with relevant tests.

  4. Run Tests and Lint Your Code

    • Make sure all existing tests pass.
    • Adhere to our linting rules (see Styleguides below).

  5. Commit and Push

    • Write clear, concise commit messages (see the Commit Messages guide).
    • Push your branch to your forked repository on GitHub.

  6. Open a Pull Request

    • From your fork on GitHub, open a Pull Request (PR) back to the original repository.
    • Provide a short description of your changes and any relevant context.
    • We’ll review your PR, offer feedback, and merge it once it’s ready.

Styleguides

We follow consistent coding styles to keep our codebase clean and maintainable.

Commit Messages

  • For small changes, a short one-line description is sufficient.
  • For bigger changes, include a summary followed by a more detailed explanation. 
    git commit -m "A summary of the commit."
# Then, in your text editor:
> A paragraph describing what changed and its impact.

JavaScript Styleguide

TypeScript Styleguide

Issue and Pull Request Labels

We use labels to organize our issues and pull requests. Here are the main ones:

  • bug – Indicates a problem or error in the current functionality.
  • enhancement – Suggests a feature request or improvement.
  • documentation – Refers to any doc-related updates or issues.
  • good first issue – Perfect for newcomers looking for a small, straightforward task.

If you have any questions or need help at any point, don’t hesitate to open an issue or start a discussion. We appreciate your efforts and look forward to working together!