Skip to content

Latest commit

 

History

History
114 lines (76 loc) · 4.89 KB

CONTRIBUTING.md

File metadata and controls

114 lines (76 loc) · 4.89 KB

Contributing to Sheriff

First off, thank you for considering contributing to Sheriff! Your support and involvement are crucial to the success and improvement of this project. Sheriff is a community-driven effort, and we value contributions of all kinds.

Contribution Guidelines

Sheriff thrives on community input. If you have ideas for new rules to implement or tweaks to existing ones, we encourage you to share them!

Useful contributions include fixing bugs or inconsistencies, adding or proposing new features or improving documentation.

Opening a new Issue

  • Check for duplicates: Before opening a new issue, ensure that a similar issue does not already exist. If you find a similar issue, consider upvoting the issue or adding a comment to the existing issue instead.
  • Check the docs: Before opening a new issue, ensure that the documentation does not already cover the topic, especially the troubleshooting section.
  • Be specific: If you are reporting a bug there are various way to help us better understand the problem. Consider to do any of these:
    • providing a minimal reproducible example
    • list the steps to reproduce the issue
    • provide the error logs
  • Use Discussions for ideas: If you wish to discuss open points or share ideas that do not translate well into actionable issues, please open a Discussion instead, under the appropriate Discussions tab.
  • Follow the Code of Conduct: By contributing, you agree to abide by the project’s Code of Conduct.

Opening a new Pull Request

  • Contributions orientation: if you want to contribute but don't know where to start, consider checking the good first issue labeled issues. Alternatively, consider checking the help wanted labeled issues.
  • Issues as pre-requirement policy: Please ensure there is an open issue before creating a pull request. If an issue does not exist, you need to open one first. After this, the maintainers will discuss your proposed changes and provide feedback. If the issue is approved, you can proceed by creating a pull request. Approved issues will be marked with the green approved label. If an issue hasn't been approved yet (it still has the triaging label), and you create a pull request, it will be immediately declined.
  • Small and focused: Keep your pull requests as small and as focused as possible. This will make it easier for maintainers to review and merge your changes.
  • Pass quality checks: Pull requests will only be merged if they pass the quality checks performed by the pnpm merge-checks command.
  • Update documentation: Update documentation to reflect your changes, if applicable.
  • Follow the Code of Conduct: By contributing, you agree to abide by the project’s Code of Conduct.

Development

Requirements

  • make sure Git is installed in your system

  • make sure Nodejs 20.10.X is installed in your system

  • make sure Pnpm is installed in your system. If you are not sure how to install it, use corepack:

    corepack enable

Step-by-Step Guide

  1. Start by forking this repository to your own GitHub account.

  2. Clone your fork locally with:

    git clone https://github.com/<your-username>/sheriff.git

  3. Install all required dependencies using:

    pnpm i

  4. Create a new branch for your feature or fix:

    git checkout -b new-feature

  5. Implement your changes in the codebase.

    • If you need to update the documentation website, you can run it locally with:

      pnpm dev

      The website will be available at http://localhost:3000.

    • To test @sherifforg/create-config, run:

      pnpm playground

      or:

        pnpm playground:mimic-monorepo

    • To test @sherifforg/cli, run:

      playground:cli-checks

  6. If the PR contains a feature or a bugfix (meaning that it's not a chore, a documentation update or a refactoring), add a changeset:

    pnpm changeset

  7. Write clear, concise commit messages. Make sure to follow the Conventional Commits specification:

    git commit -am 'feat(context): added feature'

  8. Push your branch to your fork:

    git push origin new-feature

  10. Open a Pull Request: Submit your changes by creating a pull request to the main repository.

Thank you for helping make Sheriff a better project for everyone!