|
| 1 | +# Mojo Contributor Guide |
| 2 | + |
| 3 | +Welcome to the Mojo community! 🔥 We’re very excited that you’re interested in |
| 4 | +contributing to the project. To help you get started and ensure a smooth |
| 5 | +process, we’ve put together this contributor guide. |
| 6 | + |
| 7 | +## 1. First-time checklist |
| 8 | + |
| 9 | +Before you start your first pull request, please complete this checklist: |
| 10 | + |
| 11 | +- Read this entire contributor guide. |
| 12 | +- Read the [Code of Conduct](CODE_OF_CONDUCT.md). |
| 13 | + |
| 14 | +## 2. Evaluate and get buy-in on the change |
| 15 | + |
| 16 | +We want to be sure that you spend your time efficiently and prepare changes |
| 17 | +that aren’t controversial and get stuck in long rounds of reviews. |
| 18 | + |
| 19 | +If your change is any one of the following, please create a pull request and we |
| 20 | +will happily accept it as quickly as possible: |
| 21 | + |
| 22 | +- Code improvement: |
| 23 | + - Bug fix |
| 24 | + - Performance improvement |
| 25 | + - Code readability improvement |
| 26 | + - Conformity to style improvement (TODO: publish code style guide) |
| 27 | +- Documentation improvement: |
| 28 | + - Typo fix |
| 29 | + - Markup/rendering fix |
| 30 | + - Factual information fix |
| 31 | + - New factual information for an existing page |
| 32 | + |
| 33 | +Before embarking on any major change, please **create an issue** or **start a |
| 34 | +discussion**, so we can collaborate and agree on a solution. |
| 35 | + |
| 36 | +For example, refactoring an entire code example or adding an entire new page to |
| 37 | +the documentation is a lot of work and it might conflict with other work that’s |
| 38 | +already in progress. We don’t want you to spend time on something that might |
| 39 | +require difficult reviews and rework, or that might get rejected. |
| 40 | + |
| 41 | +## 3. Create a pull request |
| 42 | + |
| 43 | +If your change is one of the improvements described above or it has been |
| 44 | +discussed and agreed upon by the project maintainers, please create a pull |
| 45 | +request into the `main` branch and include the following: |
| 46 | + |
| 47 | +- A short commit message. |
| 48 | + |
| 49 | +- A detailed commit description that includes rationalization for the change |
| 50 | +and/or explanation of the problem that it solves, with a link to any relevant |
| 51 | +GitHub issues. |
| 52 | + |
| 53 | +- A `Signed-off-by` line, as per the [Developer Certificate of |
| 54 | +Origin](#signing-your-work). |
| 55 | + |
| 56 | +**Note:** Documentation changes might not be visible on the website until the |
| 57 | +next Mojo release. |
| 58 | + |
| 59 | +Thank you for your contributions! ❤️ |
| 60 | + |
| 61 | +### Signing your work |
| 62 | + |
| 63 | +For each pull request, we require that you certify that you wrote the change or |
| 64 | +otherwise have the right to pass it on as an open-source patch by adding a line |
| 65 | +at the end of your commit description message in the form of: |
| 66 | + |
| 67 | +`Signed-off-by: Jamie Smith <[email protected]>` |
| 68 | + |
| 69 | +You must use your real name to contribute (no pseudonyms or anonymous |
| 70 | +contributions). If you set your `user.name` and `user.email` git configs, you |
| 71 | +can sign your commit automatically with `git commit -s`. |
| 72 | + |
| 73 | +Doing so serves as a digital signature in agreement to the following Developer |
| 74 | +Certificate of Origin (DCO): |
| 75 | + |
| 76 | +```text |
| 77 | +Developer Certificate of Origin |
| 78 | +Version 1.1 |
| 79 | +
|
| 80 | +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. |
| 81 | +1 Letterman Drive |
| 82 | +Suite D4700 |
| 83 | +San Francisco, CA, 94129 |
| 84 | +
|
| 85 | +Everyone is permitted to copy and distribute verbatim copies of this |
| 86 | +license document, but changing it is not allowed. |
| 87 | +
|
| 88 | +Developer's Certificate of Origin 1.1 |
| 89 | +
|
| 90 | +By making a contribution to this project, I certify that: |
| 91 | +
|
| 92 | +(a) The contribution was created in whole or in part by me and I |
| 93 | + have the right to submit it under the open source license |
| 94 | + indicated in the file; or |
| 95 | +
|
| 96 | +(b) The contribution is based upon previous work that, to the best |
| 97 | + of my knowledge, is covered under an appropriate open source |
| 98 | + license and I have the right under that license to submit that |
| 99 | + work with modifications, whether created in whole or in part |
| 100 | + by me, under the same open source license (unless I am |
| 101 | + permitted to submit under a different license), as indicated |
| 102 | + in the file; or |
| 103 | +
|
| 104 | +(c) The contribution was provided directly to me by some other |
| 105 | + person who certified (a), (b) or (c) and I have not modified |
| 106 | + it. |
| 107 | +
|
| 108 | +(d) I understand and agree that this project and the contribution |
| 109 | + are public and that a record of the contribution (including all |
| 110 | + personal information I submit with it, including my sign-off) is |
| 111 | + maintained indefinitely and may be redistributed consistent with |
| 112 | + this project or the open source license(s) involved. |
| 113 | +``` |
0 commit comments