|
| 1 | +--- |
| 2 | +title: Creating PRs |
| 3 | +description: How to propose code changes to Magnitude |
| 4 | +icon: hammer |
| 5 | +--- |
| 6 | + |
| 7 | +## Accepted PRs |
| 8 | + |
| 9 | +Before you dive into making code changes, you should understand whether your work is likely to get merged! |
| 10 | + |
| 11 | +Generally accepted PRs: |
| 12 | +- Bugfixes (for known or newly identified issues) |
| 13 | +- [Open issues](https://github.com/magnitudedev/magnitude/issues), especially issues that are affecting or blocking multiple people. |
| 14 | + |
| 15 | +However, if there's something else you plan to implement - feel free to create an issue for it or run it by us on Discord first. You can wing it and create the PR too, but no guarantees it will be accepted. |
| 16 | + |
| 17 | +<Info> If you're ever not sure if a PR is likely to get accepted, feel free to ping us on Discord. Keep in mind that even a working implementation of a feature or resolving an issue may recieve additional scrutiny based on conventions or quality. </Info> |
| 18 | + |
| 19 | +Other general guidelines: |
| 20 | +- Changes in `magnitude-test` are more likely to be accepted quickly as the surface area to gain feature-parity with other test runners is quite large. |
| 21 | +- Changes to `magnitude-core` may also be accepted but may want to run these past us on Discord first. |
| 22 | + |
| 23 | + |
| 24 | +## PR Creation Process |
| 25 | + |
| 26 | +To make a contribution to Magnitude, follow this process: |
| 27 | + |
| 28 | +<Steps> |
| 29 | + <Step title="🍴 Create a fork for your PR"> |
| 30 | + First, fork the Magnitude monorepo on GitHub into a version that lives on your account. This will enable you to push changes onto your fork that you can use to create PRs into the main repo. |
| 31 | + |
| 32 | + 1. Go to https://github.com/magnitudedev/magnitude |
| 33 | + 2. Click "Fork", name it whatever, then "Create fork" |
| 34 | + 3. Clone your fork locally |
| 35 | + </Step> |
| 36 | + <Step title="⚙️ Set up Magnitude monorepo"> |
| 37 | + Follow the [Development Setup](/contributing/setup) instructions. |
| 38 | + </Step> |
| 39 | + <Step title="🛠️ Make a change"> |
| 40 | + Create changes and push them to your fork, adhering to the conventions listed below. |
| 41 | + </Step> |
| 42 | + <Step title="📬 Submit a PR"> |
| 43 | + [Create a PR](https://github.com/magnitudedev/magnitude/pulls) in the Magnitude repository requesting to merge from the appropriate branch on your fork. |
| 44 | + |
| 45 | + Follow instructions below for what should be included in your [PR Description](#pr-description). |
| 46 | + </Step> |
| 47 | + <Step title="📝 Follow the review process"> |
| 48 | + We regularly keep an eye out for new PRs - and may leave comments about any additional changes you may need to make in order for your PR to be merged. |
| 49 | + |
| 50 | + Once we've taken a look - if the PR looks good, it'll be merged and you'll officially be a Magnitude contributor 😎 |
| 51 | + |
| 52 | + Upon the next release, your changes will be live and everyone can enjoy your contributions! 🎉 |
| 53 | + |
| 54 | + |
| 55 | + </Step> |
| 56 | +</Steps> |
| 57 | + |
| 58 | +<Info>PRs will be reviewed and accepted on a case-by-case basis. Submitting a PR does not guarantee that your work will be merged.</Info> |
| 59 | + |
| 60 | +## PR Checklist |
| 61 | + |
| 62 | +There's a few things you should be sure to do in any PR. Please follow these steps to help your PR get merged smoothly. |
| 63 | + |
| 64 | +### ✅ Manually verify your own changes |
| 65 | +You should confirm your changes are working as expected, for example by using yalc to publish and test locally (see [local testing](/contributing/setup#local-testing)). |
| 66 | + |
| 67 | +### ✅ Add a clear description |
| 68 | +If you've implemented a new feature, give example usage that demonstrates what changes you've made. You should also describe what you've done to confirm that your changes are working as expected (any manual testing). |
| 69 | + |
| 70 | +### ✅ Create a `changeset` describing your changes: |
| 71 | + |
| 72 | +Once you've made your other changes, run this from monorepo root: |
| 73 | +``` |
| 74 | +bun changeset add |
| 75 | +``` |
| 76 | +In this menu, add a comment describing your change. Unless it's a big change and you've received confirmation that your change should be a `major` or `minor` version bump, ensure that your changeset is marked as `patch`. |
| 77 | + |
| 78 | +Commit this changeset file. This will ensure that the next release is tracking your change and will credit you as the author for the change. |
| 79 | + |
| 80 | +### ✅ Update docs |
| 81 | + |
| 82 | +If you've made a dev-facing change and there is an appropriate place in the docs that needs updating, feel free to do so. |
| 83 | + |
| 84 | +This is not required, but we appreciate it! |
0 commit comments