Skip to content

docs: update contribution guides [skip-bc] #4051

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.

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

Merged
merged 7 commits into from
Oct 28, 2024

Conversation

shortcuts
Copy link
Member

🧭 What and Why

🎟 JIRA Ticket: https://algolia.atlassian.net/browse/DI-3114

Changes included:

some feedbacks reported by @e-krebs for the contribution guides, also some alignment on the names scripts->docs

@shortcuts shortcuts self-assigned this Oct 28, 2024
@algolia-bot
Copy link
Collaborator

algolia-bot commented Oct 28, 2024

No code generated

If you believe code should've been generated, please, report the issue.

📊 Benchmark results

Benchmarks performed on the method using a mock server, the results might not reflect the real-world performance.

Language Req/s
go 1651
javascript 1624
php 1483
csharp 1371
java 1113
python 1015
ruby 891
swift 746

@shortcuts shortcuts changed the title docs: update contribution guides docs: update contribution guides [skip-bc] Oct 28, 2024
@shortcuts shortcuts marked this pull request as ready for review October 28, 2024 14:17
@shortcuts shortcuts requested a review from a team as a code owner October 28, 2024 14:17
Copy link

github-actions bot commented Oct 28, 2024

Copy link
Collaborator

@millotp millotp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is so nice

Make sure to have Docker installed so you don't have to install the tooling for every API clients. [Installation guide](https://docs.docker.com/desktop/mac/install/)
Make sure to have:
- [Docker installed so you don't have to install the tooling for every API clients](https://docs.docker.com/desktop/mac/install/)
- [jq because it's nice](https://jqlang.github.io/jq/download/)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️


:::
This step is optional, using `yarn cli ...` should work perfectly as well.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but it's slower

Screenshot 2024-10-28 at 15 42 52

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yup but a bit intrusive so... that's fine I guess

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

apic is mostly about the auto-completion rather than the speed, I think this is the main advantage

### Build many snippets for specific language

```bash
apic build snippets php insights recommend search
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

php build is a noop still 😢
phpstan is too hard

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can put python instead :trollface:

@shortcuts shortcuts requested a review from millotp October 28, 2024 15:09
@shortcuts shortcuts enabled auto-merge (squash) October 28, 2024 15:09
Copy link
Collaborator

@millotp millotp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

gg

@shortcuts shortcuts merged commit 8876e4b into main Oct 28, 2024
28 checks passed
@shortcuts shortcuts deleted the docs/improve-contributing-guides branch October 28, 2024 15:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants