chore: prepare repository for open source release (#20)

frankieyan · web-flow · commit 801379545362 · 2026-01-16T15:12:36.000-08:00
* docs(security): fix placeholder URL in SECURITY.md Replace {repository-url} placeholder with actual GitHub repository URL. * chore: update CODEOWNERS with frontend-product team Replace placeholder with @Doist/frontend-product team. * chore: remove unused dependabot.yml This repository uses Renovate for dependency updates instead of Dependabot. * docs: add CONTRIBUTING.md Add contribution guidelines including: - Code of Conduct reference - Open development policy - Semantic versioning explanation - Branch organization - How to propose changes - Project setup instructions - Development workflow and available commands - Pull request guidelines - Commit message guidelines (Conventional Commits) * docs: add CODE_OF_CONDUCT.md Add Contributor Covenant v2.1 code of conduct with Doist contact email (frontend+opensource@doist.com) for enforcement.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -1 +1 @@
-* @{username-or-team-name}
+* @doist/frontend-product
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,83 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+-   Demonstrating empathy and kindness toward other people
+-   Being respectful of differing opinions, viewpoints, and experiences
+-   Giving and gracefully accepting constructive feedback
+-   Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+-   Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+-   The use of sexualized language or imagery, and sexual attention or advances of any kind
+-   Trolling, insulting or derogatory comments, and personal or political attacks
+-   Public or private harassment
+-   Publishing others' private information, such as a physical or email address, without their explicit permission
+-   Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at frontend+opensource@doist.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][mozilla coc].
+
+For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][faq]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[mozilla coc]: https://github.com/mozilla/diversity
+[faq]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,110 @@
+# Contributing to react-compiler-tracker
+
+The following is a set of guidelines for contributing to react-compiler-tracker. Please spend several minutes reading these guidelines before you create an issue, pull request or discussion.
+
+## Code of Conduct
+
+Doist has adopted the [Contributor Covenant](https://www.contributor-covenant.org/) as its Code of Conduct, and we expect contributors to react-compiler-tracker to adhere to it. Please read [the full text](https://github.com/Doist/react-compiler-tracker/blob/main/CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
+
+## Open Development
+
+All work on react-compiler-tracker happens directly on [GitHub](https://github.com/Doist/react-compiler-tracker). Both core team members and external contributors send pull requests that go through the same review process.
+
+## Semantic Versioning
+
+react-compiler-tracker follows [semantic versioning](https://semver.org/). We release patch versions for critical bugfixes, minor versions for new features or non-essential changes, and major versions for any breaking changes.
+
+Every significant change is documented in the [CHANGELOG.md](CHANGELOG.md) file.
+
+## Branch Organization
+
+Submit all changes directly to the [main](https://github.com/Doist/react-compiler-tracker/tree/main) branch. We don't use separate branches for development or for upcoming releases. We do our best to keep `main` in good shape, with all tests passing.
+
+## Proposing a Change
+
+If you intend to change the public API, or make any non-trivial changes to the implementation, we recommend opening a [GitHub Discussion](https://github.com/Doist/react-compiler-tracker/discussions) with the core team first. Although we welcome all contributions, this lets us reach an agreement on your proposal before you put significant effort into something that might not fit Doist product requirements.
+
+## Your First Pull Request
+
+Working on your first Pull Request? You can learn how from this free video series:
+
+-   [How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)
+
+If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don't accidentally duplicate your effort.
+
+## Project Setup
+
+Before you can contribute to the codebase, you will need to fork the react-compiler-tracker repository, and the following steps will help you hit the ground running:
+
+1. Fork the repository (click the <kbd>Fork</kbd> button at the top right of [this page](https://github.com/Doist/react-compiler-tracker));
+
+2. Clone your fork locally;
+
+```sh
+git clone https://github.com/<your_github_username>/react-compiler-tracker.git
+cd react-compiler-tracker
+```
+
+3. Install all dependencies by running `npm install`;
+
+## Development Workflow
+
+After cloning react-compiler-tracker and installing all dependencies, several commands are at your disposal:
+
+-   `npm run build`: Builds the `@doist/react-compiler-tracker` package for publishing to [npm](https://www.npmjs.com/);
+-   `npm run check`: Validates code quality and types with Biome and TypeScript;
+-   `npm run fix`: Automatically fixes linting issues with Biome;
+-   `npm run test`: Runs all unit tests with Vitest;
+-   `npm run test:watch`: Runs tests in watch mode.
+
+### Release Process (core team only)
+
+The release process for react-compiler-tracker is automated with [release-please](https://github.com/googleapis/release-please). When commits following the [Conventional Commits](https://www.conventionalcommits.org/) specification are merged to `main`, release-please automatically creates or updates a release PR. When that PR is merged, a new version is published to npm.
+
+## Sending a Pull Request
+
+Pull requests are actively monitored, and only need the approval of one or more core team members. We will review your pull request and either merge it, request changes to it, or close it with an explanation.
+
+Before submitting a pull request, please take the following into consideration:
+
+-   Fork [the repository](https://github.com/Doist/react-compiler-tracker) and create your branch from `main`;
+-   Follow the [Commit Message Guidelines](#commit-message-guidelines) below;
+-   Add tests for code that should be tested (like bug fixes);
+-   Ensure the test suite passes with flying colours;
+-   Do not override built-in validation and formatting checks.
+
+### Commit Message Guidelines
+
+#### Atomic Commits
+
+If possible, make [atomic commits](https://en.wikipedia.org/wiki/Atomic_commit), which means:
+
+-   A commit should not mix whitespace and/or code style changes with functional code changes;
+-   A commit should contain exactly one self-contained functional change;
+-   A commit should not create an inconsistent state (e.g., test errors, linting errors, partial fix, etc.).
+
+#### Commit Message Format
+
+This repository expects all commit messages to follow the [Conventional Commits Specification](https://www.conventionalcommits.org/) to automate semantic versioning and `CHANGELOG.md` generation.
+
+As a quick summary, each commit message consists of a **header**, an **optional body**, and an **optional footer**. The header has a special format that includes a **type**, an **optional scope**, and a **description**:
+
+```
+<type>[optional scope]: <description>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+Commit types, such as `feat:` or `fix:`, are the only ones that will affect versioning and `CHANGELOG.md` generation, whereas commit types such as `build:`, `chore:`, `ci:`, `docs:`, `perf:`, `refactor:`, `revert:`, `style:` and `test:` will not. They are still valid, and it would be great if you could use them when appropriate.
+
+A commit that has the text `BREAKING CHANGE:` at the beginning of its optional body or footer section, or appends a `!` after the type/scope, introduces a breaking API change (correlating with `MAJOR` in Semantic Versioning). A breaking change can be part of commits of any _type_.
+
+## License
+
+By contributing to react-compiler-tracker, you agree that your contributions will be licensed under its [MIT license](LICENSE).
+
+## Attribution
+
+This document is based on [reactjs.org contributing guidelines](https://reactjs.org/docs/how-to-contribute.html).
diff --git a/SECURITY.md b/SECURITY.md
@@ -6,6 +6,6 @@ At the moment, we only officially support the latest version of the project with
 
 ## Reporting a vulnerability
 
-Please report any vulnerabilities by [opening an issue]({repository-url}/issues/new) and including as many details as you can. We will prioritize security reports over other issues.
+Please report any vulnerabilities by [opening an issue](https://github.com/Doist/react-compiler-tracker/issues/new) and including as many details as you can. We will prioritize security reports over other issues.
 
 We don't currently offer a bounty for OSS vulnerabilities, but if it affects [one of the eligible targets, you might qualify for a reward](https://todoist.com/help/articles/doist-bug-bounty-policy).

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-* @{username-or-team-name}`
	`1`	`+* @doist/frontend-product`