Skip to content

Commit

Permalink
fix text
Browse files Browse the repository at this point in the history
  • Loading branch information
taliyada committed Sep 6, 2023
1 parent 8aae341 commit 9afcc57
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 7 deletions.
3 changes: 1 addition & 2 deletions CODING_GUIDELINES.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,7 @@ In particular, you should always comment any decision that:
* Takes a significant amount of time to produce. A good rule of thumb here is that if you spent more than 1 hour
thinking on how to produce a fragment of code that took 2 minutes of wrist time to write you should document your
thinking to aid reader and allow for validation.
* Need to preserve properties of the implementation. This is the case of performance sensitive portions of the codebase,
goroutines synchronization, implementations of security primitives, congestion control algorithms, etc.
* Need to preserve properties of the implementation. This is the case of performance sensitive portions of the codebase, implementations of security primitives, congestion control algorithms, etc.

As a general rule of what not to comment you should avoid:

Expand Down
9 changes: 4 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ guidelines will be disregarded and told to make the required modifications to do
## Request For Change / Feature Request

Generally speaking an RFC is needed when you want to add a new feature or change an existing one in an incompatible way
that might result in a major version bump to the toolkit.
that might result in a major version bump to the SDK.

Though it seems a little bureaucratic, the process is in place in order to avoid frustration of a potential contributor
by making the discussions take place before any code is written. Once the design and direction is fully agreed then the
Expand Down Expand Up @@ -68,13 +68,12 @@ push changes to their personal fork and create pull requests to bring those chan

Your basic steps to get going:

* Fork the corresponding toolkit repository and create a branch from master for the issue you are working on.
* Fork the corresponding SDK repository and create a branch from master for the issue you are working on.
* Commit as you go following our git conventions.
* Include tests that cover all non-trivial code. The existing tests should provide a template on how to test the toolkit
correctly.
* Include tests that cover all non-trivial code. The existing tests should provide a template on how to test the SDK correctly.
* Make sure all test passes.
* All code changes are expected to comply with the formatting style.
* Push your commits to GitHub and create a pull request against the corresponding toolkit component master branch.
* Push your commits to GitHub and create a pull request against the corresponding SDK component master branch.

If taking too much time to deliver code, **always** [rebase](https://git-scm.com/docs/git-rebase) towards `master` before
asking for a review, and avoid reverse merge commits.

0 comments on commit 9afcc57

Please sign in to comment.