Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update contributing guidelines #10223

Merged
merged 16 commits into from
Oct 1, 2021
Merged

docs: update contributing guidelines #10223

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
1ba7fb1
docs: update contributing guidelines
robert-zaremba Sep 23, 2021
8b56f04
update wording
robert-zaremba Sep 23, 2021
f050544
Apply suggestions from code review
robert-zaremba Sep 27, 2021
3610807
Apply suggestions from code review
robert-zaremba Sep 27, 2021
36b31fb
Update CONTRIBUTING.md
robert-zaremba Sep 27, 2021
862297f
Merge branch 'master' into robert/contributing
robert-zaremba Sep 28, 2021
dd1edb1
Apply suggestions from code review
robert-zaremba Sep 29, 2021
7f3153c
review updates
robert-zaremba Sep 29, 2021
22232ea
update the notes
robert-zaremba Sep 29, 2021
d9217a4
rename CONTRIBUTING-GUIDELINES
robert-zaremba Sep 29, 2021
be26d0d
Apply suggestions from code review
robert-zaremba Sep 30, 2021
8add173
fix a link
robert-zaremba Sep 30, 2021
8661c19
merging release process with stable release document
robert-zaremba Sep 30, 2021
c87a036
rename CODING-GUIDELINES
robert-zaremba Oct 1, 2021
a2c3b4e
Merge remote-tracking branch 'origin/master' into robert/contributing
robert-zaremba Oct 1, 2021
e28157a
language improvements
robert-zaremba Oct 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
rename CONTRIBUTING-GUIDELINES
  • Loading branch information
@robert-zaremba
robert-zaremba committed Sep 29, 2021
commit d9217a49e10b9b5ebc803f61d8fbd8c96e788db5
2 changes: 1 addition & 1 deletion CONTRIBUTING-GUIDELINES.md → CODING-GUIDELINES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This document is an extension to [CONTRIBUTING](./CONTRIBUTING.md) and provides
+ publicly-exposed functions are named logically, have forward-thinking arguments and return types.
+ Avoid global variables and global configurators.
+ Favor composable and extensible designs.
+ Minimize code duplicaiton.
+ Minimize code duplication.
+ Limit third-party dependencies.

Performance:
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ When proposing an architecture decision for the SDK, please start by opening an
Additionally please ensure that your code is lint compliant by running `make lint-fix`.
A convenience git `pre-commit` hook that runs the formatters automatically
before each commit is available in the `contrib/githooks/` directory.
- Follow the [CONTRIBUTING GUIDELINES](CONTRIBUTING-GUIDELINES.md).
- Follow the [CODING GUIDELINES](CODING-GUIDELINES.md), which defines criteria for designing and coding a software.

Code is merged into master through pull request procedure.

Expand Down