From 6b706f739a82ec0728033243c277f4c533b0fe8c Mon Sep 17 00:00:00 2001 From: Stefanni Brasil Date: Fri, 12 Jan 2024 09:32:38 -0700 Subject: [PATCH] Freeze new generator and locales (#2886) * Freeze new generator and locales As we discussed here https://github.com/orgs/faker-ruby/discussions/2877 we want to improve faker's performance and organization. There hasn't been to many bug reports and most of the open issues are related to performance and confusion around using faker. As we have limited time to invest in faker, reviewing new generators and locales take lots of our time. With this decision, we hope to make the necessary changes for faker to go to the next level. * Reinforce what contributors we will accept during the freeze --- .github/ISSUE_TEMPLATE/feature-request.md | 22 ---------------------- CONTRIBUTING.md | 9 ++------- README.md | 2 ++ 3 files changed, 4 insertions(+), 29 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.md diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index 6683334ffe..0000000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: Feature Request -about: Suggest a new feature -title: "Title goes here" -labels: "💡 Issue: Feature Request" -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe it.** -A clear and concise description of what the problem is. - -**If you're adding new objects, please describe how you would use them** -Provide examples of how the proposed feature could be useful and relevant. - -For example, if proposing a new generator, explain why it's useful and relevant to Faker, and examples of how to use it in a real project. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fd6c962eed..4eb0712a95 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -81,14 +81,9 @@ There are a few ways to run RuboCop: ## Adding new generators/locales -New generators will only be added to the gem after: +The faker-ruby team has decided to stop accepting any new features, including generators and locales. Please see [What contributions we are looking for](#what-contributions-we-are-looking-for) for other ways you can help. -- there's been a poll in the [community](https://github.com/orgs/faker-ruby/discussions/categories/new-feature-locale-generator). Use this to get feedback on how others would use it, what edge cases to cover, etc. -- the community is interested in the feature. - -This allow us to measure the interest and see some traction before we decide to accept the proposal for a new generator. - -**Note**: we will not accept new generators/locales that do not follow the requirements above. +This allows us to focus on improving the performance and organization of the library. We appreciate your understanding and we are looking forward to get your help with making faker faster and easier to use. ### General Guidelines diff --git a/README.md b/README.md index 3c76f3d8ef..a67d12d7cf 100644 --- a/README.md +++ b/README.md @@ -479,6 +479,8 @@ gem 'faker', :git => 'https://github.com/faker-ruby/faker.git', :branch => 'main ## Contributing +**Note**: We are not accepting proposals for new generators and locales. The [Contributing](CONTRIBUTING.md) guide has a few notes about this decision. + Take a look at the [Contributing](CONTRIBUTING.md) document for instructions on setting up the repo on your machine, opening bug reports, understanding the codebase, and creating a good pull request.