Add contributing guidelines for the repository #2
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
documentation
0237h
added a commit
that referenced
this pull request
Apr 19, 2024
* Make Release Drafter follow `develop` branch * Add CONTRIBUTING.md and update README.md
0237h
added a commit
that referenced
this pull request
Apr 22, 2024
* Make workflow separate `develop` from `release` tags for artifact builds * Add comments and replace `console` log * Add contributing guidelines for the repository (#2) * Make Release Drafter follow `develop` branch * Add CONTRIBUTING.md and update README.md * Results pagination overhaul (#3) * Replace `offset` parameter with `page` for pagination of results Instead of taking the offset directly from the user query, we can compute it by multiplying the page number with the `limit` parameter set in the query or by default. Not having a `page` parameter in the query is equivalent to `page=1`. * Fix `limit <= 0` and add missing tests * Add `parsePage` tests * Add metadata information to API responses The metadata contains information for the pagination of results. The following fields are available: - `next_page`, capped to `total_pages` on reaching the last page - `previous_page`, set to 1 on the first page - `total_pages`, computed from the `limit` parameter - `total_results` returned from `rows_before_limit_at_least` of ClickHouse's response (https://clickhouse.com/docs/en/interfaces/formats#json) * Make `limit` parameter default to `config.maxLimit` Resolves #1 * Edit automation and documentation to drop `develop` (#4) Given the relatively small size of the repo, it will be easier to use to make PRs directly to the `main` branch, keeping the current tagging schema intact. PRs would still be required before merging to `main` following the conventions described in `CONTRIBUTING.md`.
0237h
added a commit
that referenced
this pull request
Apr 22, 2024
* Make workflow separate `develop` from `release` tags for artifact builds * Add comments and replace `console` log * Add contributing guidelines for the repository (#2) * Make Release Drafter follow `develop` branch * Add CONTRIBUTING.md and update README.md * Results pagination overhaul (#3) * Replace `offset` parameter with `page` for pagination of results Instead of taking the offset directly from the user query, we can compute it by multiplying the page number with the `limit` parameter set in the query or by default. Not having a `page` parameter in the query is equivalent to `page=1`. * Fix `limit <= 0` and add missing tests * Add `parsePage` tests * Add metadata information to API responses The metadata contains information for the pagination of results. The following fields are available: - `next_page`, capped to `total_pages` on reaching the last page - `previous_page`, set to 1 on the first page - `total_pages`, computed from the `limit` parameter - `total_results` returned from `rows_before_limit_at_least` of ClickHouse's response (https://clickhouse.com/docs/en/interfaces/formats#json) * Make `limit` parameter default to `config.maxLimit` Resolves #1 * Edit automation and documentation to drop `develop` (#4) Given the relatively small size of the repo, it will be easier to use to make PRs directly to the `main` branch, keeping the current tagging schema intact. PRs would still be required before merging to `main` following the conventions described in `CONTRIBUTING.md`.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Explaining the repository structure and how to contribute through the
CONTRIBUTING.mdfile.