Skip to content

Latest commit

 

History

History
85 lines (61 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

85 lines (61 loc) · 1.88 KB
Raw

Contributing

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork to your local machine:
git clone https://github.com/<your-username>/fzf-ecma.git
  1. Add the original repository as a remote:
git remote add upstream https://github.com/theurgi/fzf-ecma.git
  1. Install dependencies and set up the project:
pnpm install
  1. Create a new branch for your changes:
git checkout -b feature/my-new-feature

Making Changes

  1. Make your changes in the new branch.
  2. Write tests for your changes, if applicable.
  3. Ensure all tests pass by running:
pnpm test
  1. Ensure the project builds without errors by running:
pnpm build
  1. If your changes affect the package version or require a changelog update, run pnpm changeset and follow the prompts to generate the appropriate changeset:
pnpm changeset
  1. Commit your changes with a clear and descriptive commit message.
  2. Pull the latest changes from the upstream repository and rebase your branch:
git fetch upstream
git rebase upstream/main
  1. Push your changes to your fork:
git push origin feature/my-new-feature

Opening a Pull Request

  1. Navigate to the original repository on GitHub.
  2. Click the 'Pull requests' tab.
  3. Click the 'New pull request' button.
  4. Click 'compare across forks'.
  5. In the 'head repository' dropdown, select your forked repository.
  6. In the 'compare' dropdown, select your branch.
  7. Click 'Create pull request'.
  8. Fill in the pull request form with a clear title and detailed description of your changes.
  9. Click 'Create pull request'.

Reporting Issues

If you find a bug or have a suggestion for improvement, please open a new issue in the original repository. Provide a clear and descriptive title, as well as any relevant information to help reproduce the issue or understand the suggestion.