|
| 1 | +.. _contrib_doc_dev: |
| 2 | + |
| 3 | +Contributing to the AboutCode |
| 4 | +============================= |
| 5 | + |
| 6 | +Here are some general guidelines to contribute to AboutCode both |
| 7 | +for new contributors and veterans, so you know how we do things Here |
| 8 | +and what to expect from us. If you are a new contributor, make sure you |
| 9 | +go through the entire contributing page, before you start interacting with |
| 10 | +the project through issues/PRs or in our public chatrooms. |
| 11 | + |
| 12 | +First interactions |
| 13 | +------------------ |
| 14 | + |
| 15 | +- To be completed. |
| 16 | + |
| 17 | +What can you contribute to? |
| 18 | +--------------------------- |
| 19 | + |
| 20 | +Most of our repositories have issues labeled as a `good-first-issue` |
| 21 | +to help new conributors get started, with a small, clearly described |
| 22 | +issue which helps you: |
| 23 | + |
| 24 | +- understand the codebase and the concepts |
| 25 | +- understand how we do PR reviews, and how you have to |
| 26 | + seek and integrate feedback into your PR |
| 27 | +- understand our code/documentation and other standards |
| 28 | + |
| 29 | +You can pick up an issue generally if: |
| 30 | + |
| 31 | +- It is labeled as a `good-first-issue` or you think you understand the problem/fix |
| 32 | +- Doesn't have anyone (maintainers/others) assigned |
| 33 | +- Is not assigned to a aboutcode project (see the `Projects` section on the right) |
| 34 | +- Has a PR open for the issue, but this is stale (2-3 months old) |
| 35 | +- Has an open PR, but you want to add more modifications |
| 36 | + |
| 37 | +Working on the same issue |
| 38 | +------------------------- |
| 39 | + |
| 40 | +You can work on something which others are already working on, but always try to |
| 41 | +use their commits directly or at the minimum credit them for their work. |
| 42 | +Open Source is collaborative developement, not a competetion. |
| 43 | + |
| 44 | +- Use commits directly by adding a git remote and fetching the commits from there |
| 45 | +- Clearly mention/reference the commits/PRs in your commit/PR |
| 46 | + |
| 47 | +We do not assign issues to new contributors as this blocks the issue for everyone else, |
| 48 | +and in case the issue is not resolved by the assigned person, this only hampers |
| 49 | +productivity for the project. So: |
| 50 | + |
| 51 | +- Please don't comment on the issue asking to be assigned to it |
| 52 | +- No need to comment on the issue stating that you've started working on it |
| 53 | + or expressing interest |
| 54 | +- Comment on a issue, only to ask specific questions/more details and discuss the |
| 55 | + problem/fix |
| 56 | + |
| 57 | +Use an issue to only discuss/communicate about the problem/fix, as this helps us help |
| 58 | +you contribute and also helps any other contributor, as they only need to go |
| 59 | +through the things needed for the issue. |
| 60 | + |
| 61 | +You are always encouraged to work on issues together with other contributors, and |
| 62 | +improve on PRs, with proper communication and credit. |
| 63 | + |
| 64 | +What you need to do before a PR review |
| 65 | +-------------------------------------- |
| 66 | + |
| 67 | +Reviewing a PR takes significant time from the maintainers to |
| 68 | +properly evaluate and provide feedback, and make sure the code |
| 69 | +contributed works as expected, and can be maintained. So Please |
| 70 | +make sure you've made the PR easy to review for us by doing the |
| 71 | +following: |
| 72 | + |
| 73 | +- The PR has the issue referenced clearly |
| 74 | + (or contains explanation on why it is needed) |
| 75 | +- The PR is from a current branch and there is no merge conflicts |
| 76 | +- Populate the PR template with necessary information which we ask for |
| 77 | +- All the tests for the PR pass on the CI, or the failures are explained |
| 78 | +- If you have regenerated test expectations make sure they are related to |
| 79 | + your PR and the changes make sense |
| 80 | +- Provide a commit signoff so this can be properly attributed to you |
| 81 | +- If you are changing any functionalty you have to update the CHANGELOG, |
| 82 | + documentation, and not just the code |
| 83 | +- Refrain from populating the PR title/description with AI, just write a |
| 84 | + concise summary yourself |
| 85 | +- If you are adding new functionalty or fixing an issue, you must add a test |
| 86 | + to check your fix/feature works as expected |
| 87 | + |
| 88 | + |
| 89 | +Your code must be tested |
| 90 | +------------------------- |
| 91 | + |
| 92 | +To be completed. |
| 93 | + |
| 94 | +Communicating with maintainers |
| 95 | +------------------------------ |
| 96 | + |
| 97 | +AboutCode has a small team of maintainers working on maintaining |
| 98 | +and improving all the AboutCode projects, and it might take us |
| 99 | +some time to review |
| 100 | + |
| 101 | +Why you want to follow our guidelines |
| 102 | +------------------------------------- |
| 103 | + |
| 104 | +To be completed. |
| 105 | + |
0 commit comments