paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-10-23 04:52:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Close up instances of 'codebase'.

Browse Source
This commit is contained in:
Karl Stolley
2023-05-29 12:12:01 -04:00
committed by Tim Abbott
parent 10d679d41d
commit a164173acf
3 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/contributing/code-reviewing.md
View File

@@ -1,8 +1,8 @@
# Reviewing Zulip code # Reviewing Zulip code
Code review is a key part of how Zulip does development. It's an essential Code review is a key part of how Zulip does development. It's an essential
aspect of our process to build a high-quality product with a maintainable code aspect of our process to build a high-quality product with a maintainable
base. See the [pull request review process](../contributing/review-process.md) codebase. See the [pull request review process](../contributing/review-process.md)
guide for a detailed overview of Zulip's PR review process. guide for a detailed overview of Zulip's PR review process.
## Principles of code review ## Principles of code review

6
docs/contributing/commit-discipline.md
View File

@@ -94,7 +94,7 @@ Commit messages have two parts:
In Zulip, commit summaries have a two-part structure: In Zulip, commit summaries have a two-part structure:
1. A one or two word description of the part of the code base changed 1. A one or two word description of the part of the codebase changed
by the commit. by the commit.
2. A short sentence summarizing your changes. 2. A short sentence summarizing your changes.
@@ -148,7 +148,7 @@ scan commit messages to find what they need.
Additional tips: Additional tips:
- Use lowercase (e.g., "settings", not "Settings"). - Use lowercase (e.g., "settings", not "Settings").
- If it's hard to find a 1-2 word description of the part of the code base - If it's hard to find a 1-2 word description of the part of the codebase
affected by your commit, consider again whether you have structured your affected by your commit, consider again whether you have structured your
commits well. commits well.
- Never use a generic term like "bug", "fix", or "refactor". - Never use a generic term like "bug", "fix", or "refactor".
@@ -167,7 +167,7 @@ a few rules to keep in mind:
update tests/docs," would be better written as just, "Change X," since (as update tests/docs," would be better written as just, "Change X," since (as
discussed above) _every_ commit is expected to update tests and documentation discussed above) _every_ commit is expected to update tests and documentation
as needed. as needed.
- Make it readable to someone who is familiar with Zulip's code base, but hasn't - Make it readable to someone who is familiar with Zulip's codebase, but hasn't
been involved with the effort you're working on. been involved with the effort you're working on.
- Use no more than 72 characters for the entire commit summary (parts 1 and 2). - Use no more than 72 characters for the entire commit summary (parts 1 and 2).

2
docs/contributing/review-process.md
View File

@@ -2,7 +2,7 @@
Pull requests submitted to Zulip go through a rigorous review process, which is Pull requests submitted to Zulip go through a rigorous review process, which is
designed to ensure that we are building a high-quality product with a designed to ensure that we are building a high-quality product with a
maintainable code base. This page describes the stages of review your pull maintainable codebase. This page describes the stages of review your pull
request may go through, and offers guidance on how you can help keep your pull request may go through, and offers guidance on how you can help keep your pull
request moving along. request moving along.