Skip to content

Commit

Permalink
chore: update contributing docs (#1519)
Browse files Browse the repository at this point in the history
  • Loading branch information
dsherret committed Mar 10, 2024
1 parent d24e2a7 commit eb9c24a
Showing 1 changed file with 3 additions and 8 deletions.
11 changes: 3 additions & 8 deletions 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.
Expand All @@ -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

Expand Down

0 comments on commit eb9c24a

Please sign in to comment.