Skip to content

chore: Update CONTRIBUTING.md#20641

Merged
zomars merged 2 commits intomainfrom
zomars-patch-1
Apr 10, 2025
Merged

chore: Update CONTRIBUTING.md#20641
zomars merged 2 commits intomainfrom
zomars-patch-1

Conversation

@zomars
Copy link
Contributor

@zomars zomars commented Apr 9, 2025

Summary by mrge

Improved the CONTRIBUTING.md file with clearer guidelines and streamlined structure for contributors. These changes make it easier for new and existing contributors to understand the project's contribution process and requirements.

Refactors

  • Restructured the "House Rules" section with clearer guidance on preventing work duplication, working on approved issues, and providing context from private channels.
  • Added new sections on PR summarization, using GitHub keywords to link issues, and documenting testing approaches.
  • Simplified development setup instructions by linking to the README instead of duplicating information.

Bug Fixes

  • Fixed formatting inconsistencies in the priority table for better readability.
  • Updated outdated instructions for making pull requests with current best practices.

This PR is part of a stack, managed by mrge:


What does this PR do?

This pull request includes significant updates to the CONTRIBUTING.md file to improve clarity and guidance for contributors. The changes focus on restructuring sections, enhancing readability, and linking to relevant resources.

Key Changes:

Improvements to contribution guidelines:

  • Revised the "House Rules" section to include clearer guidelines on preventing work duplication, working only on approved issues, and providing context from private channels.
  • Added new sections on summarizing PRs, using GitHub keywords to auto-link issues, and mentioning what was tested.
  • Updated the "Making a Pull Request" section to include a link to the App Contribution Guidelines and instructions on keeping branches updated.

Simplification and linking to external resources:

  • Replaced detailed development setup instructions with a link to the README for development and e2e testing. [1] [2]

These changes aim to streamline the contribution process and ensure that all necessary information is easily accessible to contributors.

Mandatory Tasks (DO NOT REMOVE)

  • I have self-reviewed the code (A decent size PR without self-review might be rejected).
  • I have updated the developer docs in /docs if this PR makes changes that would require a documentation change. If N/A, write N/A here and check the checkbox.
  • I confirm automated tests are in place that prove my fix is effective or that my feature works.

@cubic-dev-ai
Copy link
Contributor

cubic-dev-ai bot commented Apr 9, 2025

Review this PR on mrge.io

@graphite-app graphite-app bot requested a review from a team April 9, 2025 20:12
@github-actions
Copy link
Contributor

github-actions bot commented Apr 9, 2025

Hey there and thank you for opening this pull request! 👋🏼

We require pull request titles to follow the Conventional Commits specification and it looks like your proposed title needs to be adjusted.

Details:

No release type found in pull request title "Update CONTRIBUTING.md". Add a prefix to indicate what kind of release this pull request corresponds to. For reference, see https://www.conventionalcommits.org/

Available types:
 - feat: A new feature
 - fix: A bug fix
 - docs: Documentation only changes
 - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
 - refactor: A code change that neither fixes a bug nor adds a feature
 - perf: A code change that improves performance
 - test: Adding missing tests or correcting existing tests
 - build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
 - ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
 - chore: Other changes that don't modify src or test files
 - revert: Reverts a previous commit

@keithwillcode keithwillcode added core area: core, team members only foundation labels Apr 9, 2025
@dosubot dosubot bot added the docs area: docs, documentation, cal.com/docs label Apr 9, 2025
@graphite-app
Copy link

graphite-app bot commented Apr 9, 2025

Graphite Automations

"Add foundation team as reviewer" took an action on this PR • (04/09/25)

1 reviewer was added to this PR based on Keith Williams's automation.

@vercel
Copy link

vercel bot commented Apr 9, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
cal ⬜️ Ignored (Inspect) Visit Preview Apr 10, 2025 2:00am
calcom-web-canary ⬜️ Ignored (Inspect) Visit Preview Apr 10, 2025 2:00am

- Be sure to fill the PR Template accordingly.
- Review [App Contribution Guidelines](./packages/app-store/CONTRIBUTING.md) when building integrations

## Guidelines for committing yarn lockfile
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed this as this shouldn't be a problem since we don't use the submodule approach anymore

@zomars zomars enabled auto-merge (squash) April 9, 2025 20:53
@zomars zomars changed the title Update CONTRIBUTING.md chore: Update CONTRIBUTING.md Apr 9, 2025
Copy link
Contributor

@emrysal emrysal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Big fan of this! Lgtm

@zomars zomars merged commit 3719bb3 into main Apr 10, 2025
43 of 44 checks passed
@zomars zomars deleted the zomars-patch-1 branch April 10, 2025 07:03
alishaz-polymath pushed a commit that referenced this pull request May 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core area: core, team members only docs area: docs, documentation, cal.com/docs foundation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants