Skip to content

Commit

Permalink
chore: add contribution guide in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ymtdzzz committed Jan 16, 2025
1 parent 32a6cbc commit e6e2912
Showing 1 changed file with 36 additions and 6 deletions.
42 changes: 36 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,6 @@ There're a lot of things to do. Here are some of them:
- [x] Display traces
- [x] Filter traces
- [x] Show trace information
- [ ] ...
- Metrics
- [x] Metric stream
- [x] Display metric stream
Expand All @@ -147,23 +146,54 @@ There're a lot of things to do. Here are some of them:
- [ ] Flexible chart (query, selectable dimensions, etc.)
- [ ] Auto refresh chart
- [ ] Asynchronous chart rendering
- [ ] ...
- Logs
- [x] Display logs
- [x] Filter logs
- [x] Show log information
- [x] Show logs related to a specific trace or span
- [ ] ...
- UI
- [ ] Improve UI
- [ ] Add more keybindings
- [ ] ...
- Performance
- [x] Timer based refresh
- [x] Data rotation (current buffer size: 1000 service root spans and logs)
- [ ] ...
- Configurations
- [x] Port
- [ ] Refresh interval
- [ ] Buffer size
- [ ] ...

## Contribution

Contributions are always welcome! Whether it's reporting an issue, suggesting a feature, or submitting a pull request, your involvement is greatly appreciated. Below is a simple guide to help you get started.

### Creating a Pull Request

#### Fork the Repository

- Start by forking this repository to your GitHub account.

#### Make Your Changes

- Implement your changes in a new branch.

#### Write Tests

- Add tests to verify your changes. This helps ensure the stability of the project.

#### Run Lint checks and Tests

- Run the linting tools and test suite to verify your changes. Make sure everything passes before proceeding.

```
make lint
make lint-exporter
make test
make test-exporter
```

#### Open a Pull Request

- Push your branch to your forked repository.
- Open a pull request to the main repository, providing a clear description of your changes and their purpose.

Thank you for taking the time to contribute!

0 comments on commit e6e2912

Please sign in to comment.