Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: update contributing docs #1519

Merged
merged 2 commits into from
Mar 10, 2024
Merged

chore: update contributing docs #1519

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7f3b421
chore: update contributing docs
dsherret Mar 9, 2024
231b905
update
dsherret Mar 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 3 additions & 8 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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