From 88eec1da370c88ccda982ff7fab7242674fc197c Mon Sep 17 00:00:00 2001 From: Arseny Kapoulkine Date: Mon, 30 Oct 2023 09:16:59 -0700 Subject: [PATCH] Update CONTRIBUTING.md Fix the guide to point to docs and rfcs repositories for associated changes --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7aa4e74b..26579740 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,7 @@ Some questions help improve the language, implementation or documentation by ins ## Documentation -This repository hosts the language documentation in addition to implementation, which is accessible on https://luau-lang.org. +A [separate site repository](https://github.com/luau-lang/site) hosts the language documentation, which is accessible on https://luau-lang.org. Changes to this documentation that improve clarity, fix grammatical issues, explain aspects that haven't been explained before and the like are warmly welcomed. Please feel free to [create a pull request](https://help.github.com/articles/about-pull-requests/) to improve our documentation. Note that at this point the documentation is English-only. @@ -25,7 +25,7 @@ Of course, feel free to [create a pull request](https://help.github.com/articles If you're thinking of adding a new feature to the language, library, analysis tools, etc., please *don't* start by submitting a pull request. Luau team has internal priorities and a roadmap that may or may not align with specific features, so before starting to work on a feature please submit an issue describing the missing feature that you'd like to add. -For features that result in observable change of language syntax or semantics, you'd need to [create an RFC](https://github.com/luau-lang/luau/blob/master/rfcs/README.md) to make sure that the feature is needed and well designed. +For features that result in observable change of language syntax or semantics, you'd need to [create an RFC](https://github.com/luau-lang/rfcs/blob/master/README.md) to make sure that the feature is needed and well designed. Finally, please note that Luau tries to carry a minimal feature set. All features must be evaluated not just for the benefits that they provide, but also for the downsides/costs in terms of language simplicity, maintainability, cross-feature interaction etc. As such, feature requests may not be accepted even if a comprehensive RFC is written - don't expect Luau to gain a feature just because another programming language has it.