diff --git a/DEPENDENCIES.md b/DEPENDENCIES.md index 413ca80936..9505db5d44 100644 --- a/DEPENDENCIES.md +++ b/DEPENDENCIES.md @@ -1,4 +1,4 @@ -# Dependency Managagement in Prysm +# Dependency Management in Prysm Prysm is go project with many complicated dependencies, including some c++ based libraries. There are two parts to Prysm's dependency management. Go modules and bazel managed dependencies. Be sure @@ -28,7 +28,7 @@ including complicated c++ dependencies. One key advantage of Bazel over vanilla `go build` is that Bazel automatically (re)builds generated pb.go files at build time when file changes are present in any protobuf definition file or after any updates to the protobuf compiler or other relevant dependencies. Vanilla go users should run -the following scripts often to ensure their generated files are up to date. Further more, Prysm +the following scripts often to ensure their generated files are up to date. Furthermore, Prysm generates SSZ marshal related code based on defined data structures. These generated files must also be updated and checked in as frequently. diff --git a/config/features/README.md b/config/features/README.md index a6b7d2c9cd..e4881155d4 100644 --- a/config/features/README.md +++ b/config/features/README.md @@ -35,7 +35,7 @@ your flag since you're going to invert the flag in a later step. i.e you will us later. For example, `--enable-my-feature`. Additionally, [create a feature flag tracking issue](https://github.com/prysmaticlabs/prysm/issues/new?template=feature_flag.md) for your feature using the appropriate issue template. 2. Use the feature throughout the application to enable your new functionality and be sure to write -tests carefully and thoughtfully to ensure you have tested all of your new funcitonality without losing +tests carefully and thoughtfully to ensure you have tested all of your new functionality without losing coverage on the existing functionality. This is considered an opt-in feature flag. Example usage: ```go func someExistingMethod(ctx context.Context) error { @@ -58,4 +58,4 @@ the config value in shared/featureconfig/config.go. deprecate the opt-out feature flag, delete the config field from shared/featureconfig/config.go, delete any deprecated / obsolete code paths. -Deprecated flags are deleted upon each major semver point release. Ex: v1, v2, v3. \ No newline at end of file +Deprecated flags are deleted upon each major semver point release. Ex: v1, v2, v3.