Subsections of Templates
Changelog Template
Here you can find a template for project Changelog below.
Legend:
- “[+]”: New feature
- “[#]”: Bug fix
- “[~]”: Refactoring, general changes or others that doesn’t fit first two
# Changelog
## [Unreleased]
- [+] "Frequently Asked Questions" section.
- [~] Remove empty sections from CHANGELOG, they occupy too much space and
create too much noise in the file. People will have to assume that the
missing sections were intentionally left out because they contained no
notable changes.
## [v4.0.0] - 2023-06-20
- [+] "Why keep a changelog?" section.
- [+] New "Guiding Principles" sub-section to "How do I make a changelog?".
- [#] Improve "Commit log diffs" sub-section to further argument against
them.
- [#] Fix typos in Brazilian Portuguese translation.
- [~] Clarified the section on "Is there a standard change log format?".
## [v3.4.1] - 2022-06-20
- [#] Merge "Why can’t people just use a git log diff?" with "Commit log
diffs"
- [#] Fix typos in Simplified Chinese and Traditional Chinese translations.
- [+] "Who needs a changelog?" section.
- [+] "How do I make a changelog?" section.
- [~] Remove empty sections from CHANGELOG, they occupy too much space and
create too much noise in the file. People will have to assume that the
missing sections were intentionally left out because they contained no
notable changes.
- [~] Clarified the section on "Is there a standard change log format?".
ReadME Template
Here you can find a template for project ReadMe below.
## Your Coolest Project Name
Basic information about your cool project goes here.
*Assume your project is an React project forked from `create-react-app`*
#### Development Environment
Give information about how to prepare a development environment for your coolest project.
*Example:*
*This project uses `nodejs 14.15.5` with `npm 7.5.3`*
*After cloning this project and installing nodejs In the project directory, you have to run:*
*`npm install`*
*and your development environment is ready.*
If you are using a tool formatting such as prettier, clang etc. don't forget to give information about this also.
#### Available Scripts
After preparing development environment give information for available scripts.
***Examples:***
*In the project directory, you can run:*
### *`npm start`*
*Runs the app in the development mode.<br />*
*Open [http://localhost:3000](http://localhost:3000) to view it in the browser.*
*The page will reload if you make edits.<br />*
*You will also see any lint errors in the console.*
### *`npm test`*
*Launches the test runner in the interactive watch mode.<br />*
*See the section about [running tests](https://facebook.ggithub.io/create-react-app/docs/running-tests) for more information.*
### *`npm run build`*
*Builds the app for production to the `build` folder.<br />*
*It correctly bundles React in production mode and optimizes the build for the best performance.*
*The build is minified and the filenames include the hashes.<br />*
*Your app is ready to be deployed!*
### *npm run pretty*
*Format all of your code with our prettier configuration.<br/>*
*You commits are ready to push!*
#### Dependencies
List your cooles project's dependencies as a list in this section, it could be a library, other microservice etc.
#### Additional Sections
Add sections for developer guideline, third party library usage examples, how to deploy manually, project's configuration, etc.
*If anything is need to be known, go on add a new section for that knowledge!*
#### Contributors
Mention the contributors
Finally, motivate the developer who will be working the coolest project with this PS:
*Happy Hacking!*
clang Formatter
You can find the clang formatter that is being used on BISS projects below.
---
BasedOnStyle: LLVM
IndentWidth: '4'
---
Language: Cpp
AlignAfterOpenBracket: Align
AlignConsecutiveAssignments: 'false'
AlignConsecutiveBitFields: 'false'
AlignConsecutiveDeclarations: 'false'
AlignConsecutiveMacros: 'true'
AlignEscapedNewlines: Left
AlignOperands: 'true'
AlignTrailingComments: 'true'
AllowAllArgumentsOnNextLine: 'true'
AllowAllConstructorInitializersOnNextLine: 'true'
AllowAllParametersOfDeclarationOnNextLine: 'true'
AllowShortBlocksOnASingleLine: 'Always'
AllowShortCaseLabelsOnASingleLine: 'false'
AllowShortEnumsOnASingleLine: 'false'
AllowShortFunctionsOnASingleLine: Empty
AllowShortIfStatementsOnASingleLine: Never
AllowShortLambdasOnASingleLine: Empty
AllowShortLoopsOnASingleLine: 'false'
AlwaysBreakAfterReturnType: 'None'
AlwaysBreakBeforeMultilineStrings: 'false'
AlwaysBreakTemplateDeclarations: 'Yes'
BinPackArguments: 'true'
BinPackParameters: 'true'
BreakBeforeBinaryOperators: 'None'
BreakBeforeBraces: Allman
#BreakBeforeConceptDeclarations: 'false'
BreakBeforeTernaryOperators: 'true'
BreakConstructorInitializers: BeforeColon
BreakInheritanceList: BeforeColon
BreakStringLiterals: 'true'
ColumnLimit: '100'
CompactNamespaces: 'false'
ConstructorInitializerAllOnOneLineOrOnePerLine: 'false'
ContinuationIndentWidth: '4'
Cpp11BracedListStyle: 'true'
#EmptyLineBeforeAccessModifier: LogicalBlock
FixNamespaceComments: 'true'
IncludeBlocks: 'Regroup'
#IndentAccessModifiers: 'true'
IndentCaseBlocks: 'false'
IndentCaseLabels: 'true'
IndentExternBlock: 'Indent'
IndentPPDirectives: 'None'
#IndentRequires: 'true'
IndentWrappedFunctionNames: 'true'
MaxEmptyLinesToKeep: '1'
NamespaceIndentation: 'None'
PointerAlignment: Left
ReflowComments: 'true'
SortIncludes: 'true'
SortUsingDeclarations: 'true'
SpaceAfterCStyleCast: 'false'
SpaceAfterLogicalNot: 'false'
SpaceAfterTemplateKeyword: 'false'
#SpaceAroundPointerQualifiers: 'Default'
SpaceBeforeAssignmentOperators: 'true'
#SpaceBeforeCaseColon: 'false'
SpaceBeforeCpp11BracedList: 'false'
SpaceBeforeCtorInitializerColon: 'true'
SpaceBeforeInheritanceColon: 'true'
SpaceBeforeParens: ControlStatements
SpaceBeforeRangeBasedForLoopColon: 'true'
SpaceBeforeSquareBrackets: 'false'
SpaceInEmptyParentheses: 'false'
SpacesBeforeTrailingComments: '2'
SpacesInAngles: 'false'
SpacesInCStyleCastParentheses: 'false'
SpacesInConditionalStatement: 'false'
SpacesInContainerLiterals: 'false'
SpacesInParentheses: 'false'
SpacesInSquareBrackets: 'false'
Standard: c++20
TabWidth: '4'
UseCRLF: 'false'
UseTab: Never
---
Language: Proto
BasedOnStyle: Google
...