chore: apply suggestions from code review

Co-authored-by: ST-DDT <ST-DDT@gmx.de>
faker-js · May 1, 2024 · b740f3c · b740f3c
1 parent bf37530
commit b740f3c
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 7 deletions.
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -61,19 +61,19 @@ function getSideBarWithExpandedEntry(entryToExpand: string): SidebarItem[] {
           link: '/contributing/code-of-conduct',
         },
         {
-          text: 'Report Bugs',
+          text: 'Reporting Bugs',
           link: '/contributing/report-bugs',
         },
         {
-          text: 'Propose a Feature',
+          text: 'Proposing a Feature',
           link: '/contributing/propose-a-feature',
         },
         {
-          text: 'Set up a Development Environment',
+          text: 'Setting up a Development Environment',
           link: '/contributing/set-up-a-development-environment',
         },
         {
-          text: 'Submit a Pull Request',
+          text: 'Submiting a Pull Request',
           link: '/contributing/submit-a-pull-request',
         },
       ],

diff --git a/docs/contributing/propose-a-feature.md b/docs/contributing/propose-a-feature.md
@@ -18,7 +18,7 @@ General criteria for new features are as follows:
 
 ## Accepting a Feature
 
-In order for a rule to be accepted in Faker, it must fulfill all the criteria listed in [General Feature Guideline](#general-feature-guideline).
+In order for a feature to be accepted in Faker, it must fulfill all the criteria listed in [General Feature Guideline](#general-feature-guideline).
 Additionally, depending on the type of feature, there might be additionally requirements.
 
 ::: tip Note
@@ -33,15 +33,14 @@ Faker already contains [over 60 different locales](/guide/localization#available
 
 If you want to propose a new locale that does not already exist, make sure to read our guide on [locale code names](/guide/localization#locale-codes).
 You should be able to name your locale using the provided systematic way.
-Ideally you use this name in the issues title and description.
+Ideally, you use this name in the issues title and description.
 
 ## Considerations
 
 Our goal is to maintain the library efficiently, ensuring that new features are indispensable.
 Each addition to Faker comes with associated costs.
 This encompasses initial expenses like design, implementation, review, and documentation of the feature.
 Ideally, these tasks can be delegated to the requester or another member of the community.
-Hopefully, these can be outsourced to the person requesting the feature or another person from the community.
 
 Moreover, ongoing maintenance of Faker incurs further costs, including awareness of the feature, a more intricate module structure, increased bundle size, and additional effort during refactoring.