From eb9c24a4485a67574b8fa9bcc591d008a932f9ee Mon Sep 17 00:00:00 2001 From: David Sherret Date: Sun, 10 Mar 2024 13:07:22 -0400 Subject: [PATCH] chore: update contributing docs (#1519) --- CONTRIBUTING.md | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dbe5ac91c..7669cfd50 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Logging Bugs +# Logging Bugs 1. Start logging an issue in the [issue tracker](https://github.com/dsherret/ts-morph/issues). 2. Clearly identify the problem and submit some reproduction code. @@ -15,13 +15,8 @@ # Contributing Features -1. Log an issue in the [issue tracker](https://github.com/dsherret/ts-morph/issues). In the issue: - 1. Propose the change. - - Outline all changes that will be made to the public API. - - Discuss any structural changes to the code if necessary. - 2. Wait for discussion and green light from [@dsherret](https://github.com/dsherret) (who will try to reply as soon as possible, but it might take a few days). - - Note: If the change is small and you think it wouldn't take you too much time, then feel free to start working on it and even submit a PR. Just beware that you're taking the risk that it could be denied. -2. After approval, start working on the change in a branch of `latest` and submit a PR. +- Only minor features will be accepted. +- Breaking changes that aren't bug or design fixes will not be merged. # Getting Started