From 6808086e497fc381165c6031d30e7a98e85078ac Mon Sep 17 00:00:00 2001 From: John Freeman Date: Thu, 5 Jan 2023 18:53:45 -0600 Subject: [PATCH 1/2] Revise CONTRIBUTING - Wrap text at 80 columns. - Match capitalization of GitHub usernames. - Prescribe more rules for pull requests. - Link more reference documentation. --- CONTRIBUTING.md | 173 ++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 139 insertions(+), 34 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 06b9d622cbb..73e948ac2c4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,31 +1,117 @@ +The XRP Ledger has many and diverse stakeholders, and everyone deserves +a chance to contribute meaningful changes to the code that runs the XRPL. + # Contributing -The XRP Ledger has many and diverse stakeholders, and everyone deserves a chance to contribute meaningful changes to the code that runs the XRPL. -To contribute, please: -1. Fork the repository under your own user. -2. Create a new branch on which to write your changes. Please note that changes which alter transaction processing must be composed via and guarded using [Amendments](https://xrpl.org/amendments.html). Changes which are _read only_ i.e. RPC, or changes which are only refactors and maintain the existing behaviour do not need to be made through an Amendment. -3. Write and test your code. -4. Ensure that your code compiles with the provided build engine and update the provided build engine as part of your PR where needed and where appropriate. -5. Write test cases for your code and include those in `src/test` such that they are runnable from the command line using `./rippled -u`. (Some changes will not be able to be tested this way.) -6. Ensure your code passes automated checks (e.g. clang-format and levelization.) -7. Squash your commits (i.e. rebase) into as few commits as is reasonable to describe your changes at a high level (typically a single commit for a small change.) -8. Open a PR to the main repository onto the _develop_ branch, and follow the provided template. - -# Major Changes -If your code change is a major feature, a breaking change or in some other way makes a significant alteration to the way the XRPL will operate, then you must first write an XLS document (XRP Ledger Standard) describing your change. -To do this: -1. Go to [XLS Standards](https://github.com/XRPLF/XRPL-Standards/discussions). -2. Choose the next available standard number. -3. Open a discussion with the appropriate title to propose your draft standard. -4. Link your XLS in your PR. + +We assume you are familiar with the general practice of [making contributions +on GitHub][1]. +This file includes only special instructions specific to this project. + + +## Before you start + +All of your contributions must be developed in your personal +[fork](https://github.com/XRPLF/rippled/fork). +No personal branches may ever be pushed to the [main project][rippled]. +These are the only branches that may ever exist in the main project: + +- `develop`: The latest set of unreleased features, and the most common + starting point for contributions. +- `release`: The latest release candidate. +- `master`: The latest stable release. +- `gh-pages`: The documentation for this project, built by Doxygen. + +All of your commits must be signed, +and GitHub must know your verifying key. +Please walk through the excellent documentation from GitHub to set +up [signature verification][signing]. + +[rippled]: https://github.com/XRPLF/rippled +[signing]: https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification + + +## Major contributions + +If your contribution is a major feature or breaking change, +then you must first write an XRP Ledger Standard (XLS) describing it. +Go to [XRPL-Standards](https://github.com/XRPLF/XRPL-Standards/discussions), +choose the next available standard number, and +open a discussion with an appropriate title to propose your draft standard. + +When you submit a PR for this change, please link the corresponding XLS in the +description. + + +## Before making a pull request + +Changes that alter transaction processing must be guarded by an +[Amendment](https://xrpl.org/amendments.html). +All other changes that maintain the existing behavior do not need an +Amendment. + +Ensure that your code compiles according to the build instructions in +[`BUILD.md`](./BUILD.md). +If you create new source files, they must go under `src/ripple`. +You will need to add them to one of the +[source lists](./Builds/CMake/RippledCore.cmake) in CMake. + +Please write tests for your code. +If you create new test source files, they must go under `src/test`. +You will need to add them to one of the +[source lists](./Builds/CMake/RippledCore.cmake) in CMake. +If your test can be run offline, in under 60 seconds, then it can be an +automatic test run by `rippled --unittest`. +Otherwise, it must be a manual test. + +The source must be formatted according to the style guide below. + +Header includes must be [levelized](./Builds/levelization). + + +## Pull requests + +Pull requests must target the `develop` branch.[^1] + +[^1]: There are exceptions to this policy for hotfixes, but no one consulting + this document will be in that situation. + +Changes to pull requests must be added as new commits. +You may **never force push a branch in a pull request** (e.g. after a rebase). +This preserves the ability for reviewers to filter changes since their last +review. + +A pull request must obtain **approvals from at least two reviewers** before it +can be considered for merge by a Maintainer. +Maintainers retain discretion to require more approvals if they feel the +credibility of the existing approvals is insufficient. + +Pull requests must be merged by [squash-and-merge][2] +to preserve a linear history for the `develop` branch. + # Style guide -This is a non-exhaustive list of recommended style guidelines. These are not always strictly enforced and serve as a way to keep the codebase coherent rather than a set of _thou shalt not_ commandments. + +This is a non-exhaustive list of recommended style guidelines. +These are not always strictly enforced and serve as a way to keep the codebase coherent rather than a set of _thou shalt not_ commandments. + ## Formatting -All code must conform to `clang-format` version 10, unless the result would be unreasonably difficult to read or maintain. -To change your code to conform use `clang-format -i `. + +All code must conform to `clang-format` version 10, +according to the settings in [`.clang-format`](./.clang-format), +unless the result would be unreasonably difficult to read or maintain. +To demarcate lines that should be left as-is, surround them with comments like +this: + +``` +// clang-format off +... +// clang-format on +``` + ## Avoid + 1. Proliferation of nearly identical code. 2. Proliferation of new files and classes. 3. Complex inheritance and complex OOP patterns. @@ -35,7 +121,9 @@ To change your code to conform use `clang-format -i `. 7. CPU or architecture-specific code unless there is a good reason to include it, and where it is used guard it with macros and provide explanatory comments. 8. Importing new libraries unless there is a very good reason to do so. + ## Seek to + 9. Extend functionality of existing code rather than creating new code. 10. Prefer readability over terseness where important logic is concerned. 11. Inline functions that are not used or are not likely to be used elsewhere in the codebase. @@ -43,25 +131,42 @@ To change your code to conform use `clang-format -i `. 13. Use TitleCase for classes, structs and filenames, camelCase for function and variable names, lower case for namespaces and folders. 14. Provide as many comments as you feel that a competent programmer would need to understand what your code does. + # Maintainers -Maintainers are ecosystem participants with elevated access to the repository. They are able to push new code, make decisions on when a release should be made, etc. -## Code Review -New contributors' PRs must be reviewed by at least two of the maintainers. Well established prior contributors can be reviewed by a single maintainer. +Maintainers are ecosystem participants with elevated access to the repository. +They are able to push new code, make decisions on when a release should be +made, etc. + -## Adding and Removing -New maintainers can be proposed by two existing maintainers, subject to a vote by a quorum of the existing maintainers. A minimum of 50% support and a 50% participation is required. In the event of a tie vote, the addition of the new maintainer will be rejected. +## Adding and removing -Existing maintainers can resign, or be subject to a vote for removal at the behest of two existing maintainers. A minimum of 60% agreement and 50% participation are required. The XRP Ledger Foundation will have the ability, for cause, to remove an existing maintainer without a vote. +New maintainers can be proposed by two existing maintainers, subject to a vote +by a quorum of the existing maintainers. +A minimum of 50% support and a 50% participation is required. +In the event of a tie vote, the addition of the new maintainer will be +rejected. + +Existing maintainers can resign, or be subject to a vote for removal at the +behest of two existing maintainers. +A minimum of 60% agreement and 50% participation are required. +The XRP Ledger Foundation will have the ability, for cause, to remove an +existing maintainer without a vote. + + +## Current Maintainers -## Existing Maintainers * [JoelKatz](https://github.com/JoelKatz) (Ripple) -* [Manojsdoshi](https://github.com/manojsdoshi) (Ripple) -* [N3tc4t](https://github.com/n3tc4t) (XRPL Labs) -* [Nikolaos D Bougalis](https://github.com/nbougalis) -* [Nixer89](https://github.com/nixer89) (XRP Ledger Foundation) +* [manojsdoshi](https://github.com/manojsdoshi) (Ripple) +* [n3tc4t](https://github.com/n3tc4t) (XRPL Labs) +* [Nik Bougalis](https://github.com/nbougalis) +* [nixer89](https://github.com/nixer89) (XRP Ledger Foundation) * [RichardAH](https://github.com/RichardAH) (XRPL Labs + XRP Ledger Foundation) -* [Seelabs](https://github.com/seelabs) (Ripple) +* [seelabs](https://github.com/seelabs) (Ripple) * [Silkjaer](https://github.com/Silkjaer) (XRP Ledger Foundation) * [WietseWind](https://github.com/WietseWind) (XRPL Labs + XRP Ledger Foundation) -* [Ximinez](https://github.com/ximinez) (Ripple) +* [Ed Hennis](https://github.com/ximinez) (Ripple) + + +[1]: https://docs.github.com/en/get-started/quickstart/contributing-to-projects +[2]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squash-and-merge-your-commits From b6ec61268b7b8b10912ed11dade736151309ce40 Mon Sep 17 00:00:00 2001 From: John Freeman Date: Mon, 23 Jan 2023 16:14:12 -0600 Subject: [PATCH 2/2] Incorporate review comments --- CONTRIBUTING.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 73e948ac2c4..4a09ad4b991 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,7 +21,10 @@ These are the only branches that may ever exist in the main project: - `master`: The latest stable release. - `gh-pages`: The documentation for this project, built by Doxygen. -All of your commits must be signed, +The tip of each branch must be signed. +In order for GitHub to sign a squashed commit that it builds from your pull +request, +all of your commits must be signed, and GitHub must know your verifying key. Please walk through the excellent documentation from GitHub to set up [signature verification][signing]. @@ -38,8 +41,14 @@ Go to [XRPL-Standards](https://github.com/XRPLF/XRPL-Standards/discussions), choose the next available standard number, and open a discussion with an appropriate title to propose your draft standard. -When you submit a PR for this change, please link the corresponding XLS in the +When you submit a pull request, please link the corresponding XLS in the description. +An XLS still in draft status is considered a work-in-progress and open for +discussion. +Please do not submit a pull request before allowing due time for questions, +suggestions, and changes to the XLS draft. +It is the responsibility of the XLS author to update the draft to match the +final implementation when its corresponding pull request is merged. ## Before making a pull request @@ -109,6 +118,9 @@ this: // clang-format on ``` +You can format individual files in place by running `clang-format -i ...` +from any directory within this project. + ## Avoid