Skip to content

feat: Implement code changes to enhance functionality and improve performance#72

Closed
avinxshKD wants to merge 2 commits intoPalisadoesFoundation:mainfrom
avinxshKD:add-typescript-type-checking-eslint-linting
Closed

feat: Implement code changes to enhance functionality and improve performance#72
avinxshKD wants to merge 2 commits intoPalisadoesFoundation:mainfrom
avinxshKD:add-typescript-type-checking-eslint-linting

Conversation

@avinxshKD
Copy link
Copy Markdown

What kind of change does this PR introduce?

Enhancement - Adds TypeScript type checking and ESLint linting with comprehensive rules for code quality

Issue Number:

Fixes #69

Did you add tests for your changes?

No - This PR adds linting and type-checking infrastructure, not functional changes requiring tests.

Snapshots/Videos:

N/A - Configuration changes only

If relevant, did you update the documentation?

N/A - No documentation updates required for internal tooling improvements

Summary

This PR enhances the developer experience and code quality by:

  • Implementing comprehensive ESLint configuration with TypeScript, React, Prettier, and TSDoc rules
  • Adding TypeScript type checking to the pre-commit hooks and CI pipeline
  • Integrating lint-staged for automatic formatting and linting before commits
  • Updating GitHub Actions workflow to include type checking and linting steps
  • Adding .eslintcache and *.tsbuildinfo to .gitignore to exclude generated files

These changes ensure consistent code style, catch type errors early, and enforce best practices across the codebase.

Does this PR introduce a breaking change?

No - This adds new quality checks but doesn't change existing functionality or APIs.

Other information

  • All TypeScript files in src/ will now be linted according to strict rules
  • Pre-commit hooks will run type checking and linting automatically
  • CI pipeline updated to fail on type errors or linting issues
  • Configuration files (docusaurus.config.ts, etc.) have separate relaxed linting rules

Have you read the contributing guide?

Yes

@github-actions
Copy link
Copy Markdown

Our Pull Request Approval Process

Thanks for contributing!

Testing Your Code

Remember, your PRs won't be reviewed until these criteria are met:

  1. We don't merge PRs with poor code quality.
    1. Follow coding best practices such that CodeRabbit.ai approves your PR.
  2. We don't merge PRs with failed tests.
    1. When tests fail, click on the Details link to learn more.
    2. Write sufficient tests for your changes (CodeCov Patch Test). Your testing level must be better than the target threshold of the repository
    3. Tests may fail if you edit sensitive files. Ask to add the ignore-sensitive-files-pr label if the edits are necessary.
  3. We cannot merge PRs with conflicting files. These must be fixed.

Our policies make our code better.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

  1. PRs with issues not assigned to you will be closed by the reviewer
  2. Fix the first comment in the PR so that each issue listed automatically closes

Other

  1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
  2. Read the CONTRIBUTING.md file make

@avinxshKD
Copy link
Copy Markdown
Author

@palisadoes could you please add the ignore-sensitive-files-pr label to this PR?
All checks pass except for the sensitive files validation. Thank you

@avinxshKD avinxshKD closed this Oct 16, 2025
@avinxshKD avinxshKD reopened this Oct 16, 2025
@palisadoes
Copy link
Copy Markdown
Contributor

  1. This needs to be closed.
  2. You have fundamentally changed the way docusaurus works with these changes.

Unfortunately, because of recent abuse, we will only be assigning issues to persons who have:

  1. At least a year of GitHub history
  2. Active code updates throughout their GitHub life

This is a new policy triggered by newly created accounts that:

  1. Use automation to blindly submit and update pull requests, ignoring reviewers.
  2. SPAM our volunteers to be assigned issues to the exclusion of others.
  3. Frequently abandon issues after being assigned.
  4. Frequent closing of pull requests

As expected, we need contributors who are interested in coding with a proven track record. This is an unfortunate development but the recent abuse of the system has given us no choice.

@palisadoes palisadoes closed this Oct 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Typescript Type Checking & Eslint linting to the /src directory

2 participants