Differential D29437 Diff 86374 documentation/content/en/articles/pre-commit-guide/_index.adoc

Changeset View

Standalone View

View Options

documentation/content/en/articles/pre-commit-guide/_index.adoc

This file was added.

---

title: FreeBSD Pre-Commit Best Practices

---

= FreeBSD Pre-Commit Best Practices

:doctype: article

:toc: macro

:toclevels: 1

:icons: font

:sectnums:

:sectnumlevels: 6

:source-highlighter: rouge

:experimental:

include::shared/en/urls.adoc[]

'''

toc::[]

[[pre-commit-intro]]

== Introduction

Developing code for the FreeBSD operating system has evolved over the years.

The Project has found a number of best pracitces for developing software over the years.

pauamma_gundo.comUnsubmitted

Not Done

Developing code for the FreeBSD operating system has evolved over the years.

- The Project has found a number of best pracitces for developing software over the years.

+ The Project has found a number of best practices for developing software over the years.

Developers and contributors that have followed these practices have generally produced better code than those that did not.

pauamma_gundo.com:

Developers and contributors that have followed these practices have generally produced better code than those that did not.

Software development is imperfect at best, and by following these guidelines as appropraite, higher quality code can result.

sbzUnsubmitted

Not Done

Developers and contributors that have followed these practices have generally produced better code than those that did not.

- Software development is imperfect at best, and by following these guidelines as appropraite, higher quality code can result.

+ Software development is imperfect at best, and by following these guidelines as appropriate, higher quality code can result.

This article gives advice in the following areas

sbz:

This article gives advice in the following areas

. Planning the changes

rpokalaUnsubmitted

Not Done

I don't think the "the" is necessary.

rpokala: I don't think the "the" is necessary.

. Implementation outside the tree

. Pre-commit testing

. Pre-commit code review

. Commiting the code

. Post-commit considerations

While applicable to all development, this guide is focused on those items that take substantial effort to implement.

For bug fixes, these guides can also be useful, though not all advice would be relevant.

pauamma_gundo.comUnsubmitted

Not Done

While applicable to all development, this guide is focused on those items that take substantial effort to implement.

- For bug fixes, these guides can also be useful, though not all advice would be relevant.

+ For bug fixes, this guide can also be useful, though not all advice would be relevant.

[[pre-commit-planning]]

For consistency with the previous sentence.

pauamma_gundo.com: For consistency with the previous sentence.

[[pre-commit-planning]]

== Planning

=== Design

=== Socializing Change

=== Documenting Intentions

[[pre-commit-development]]

== Implementation Guidance

=== Git Best Practices

==== Copying Files

==== Refactoring Code

==== Cleanup Commits

==== Committing with Review In Mind

=== Kernel Considerations

=== Toolchain Considerations

=== Libc and Include Files

[[pre-commit-testing]]

== Pre-Commit Testing

=== Regression Testing

==== How to use Kyua

=== Functional Testing

=== Stress Testing

==== When and how to use stress2

[[pre-commit-code-review]]

== Pre-Commit Code Review

=== Culture of Code Review

==== Benefits of Review

=== How to Structure Commits for Review

=== Phabricator

==== Using the tool

==== Accounts

=== Social Norms in Code Reviews

==== Reviewed by

==== Feedback

==== Scope of Review

==== Related Changes

=== How to Give Code Review Feedback

=== How to Accept Feedback

[[committing]]

== Comitting Your Changes

[[post-commit]]

== Post-commit Considerations

[[pre-commit-conclusion]]

pauamma_gundo.comUnsubmitted

Not Done

"pre-commit" looks out of order here?

pauamma_gundo.com: "pre-commit" looks out of order here?

== Conclusion