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.

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

Updated contribution documentation #297

Merged
merged 3 commits into from Apr 11, 2020
Merged

Updated contribution documentation #297

merged 3 commits into from Apr 11, 2020

Conversation

Razican
Copy link
Member

@Razican Razican commented Apr 2, 2020

I updated the documentation related to how to contribute to the project. I modified the usual dbg!(&tokens) and dbg!(&expr) to instead use the -t and -a CLI options, updated some links, and reduced duplication of information. I see a couple of images in the ./docs/img/ folder, but I don't see them referenced anywhere. Are we using them? Maybe they can be removed.

@github-actions
Copy link

github-actions bot commented Apr 2, 2020

Benchmark for b3bb9ee

Click to view benchmark
Test PR Benchmark Master Benchmark %
Create Realm 479.8±15.39µs 477.5±22.23µs 100%
Expression (Parser) 3.7±0.23µs 3.6±0.10µs 102%
Hello World (Execution) 498.3±14.95µs 501.0±13.08µs 99%
Hello World (Lexer) 1157.2±46.88ns 1080.3±41.96ns 107%
Hello World (Parser) 1238.1±80.33ns 1281.2±43.78ns 97%
Symbol Creation 603.1±35.92µs 597.7±23.59µs 101%
fibonacci (Execution) 5.4±0.14ms 5.5±0.12ms 98%
undefined undefined 100%

docs/debugging.md Outdated Show resolved Hide resolved
docs/debugging.md Outdated Show resolved Hide resolved
@jasonwilliams jasonwilliams added this to the v0.7.0 - New Parser milestone Apr 4, 2020
@github-actions
Copy link

github-actions bot commented Apr 9, 2020

Benchmark for dcafa44

Click to view benchmark
Test PR Benchmark Master Benchmark %
Create Realm 405.1±41.67µs 390.1±24.20µs 104%
Expression (Parser) 2.8±0.23µs 2.7±0.19µs 102%
Hello World (Execution) 409.6±25.18µs 411.7±32.64µs 99%
Hello World (Lexer) 891.3±72.41ns 903.1±53.14ns 99%
Hello World (Parser) 1020.8±75.79ns 970.0±64.55ns 105%
Symbol Creation 492.3±37.23µs 486.4±34.65µs 101%
fibonacci (Execution) 4.4±0.19ms 4.5±0.22ms 98%
undefined undefined 100%

@Razican
Copy link
Member Author

Razican commented Apr 9, 2020

I did the requested changes :) it should be ready for a merge.

@github-actions
Copy link

github-actions bot commented Apr 9, 2020

Benchmark for 4c0024d

Click to view benchmark
Test PR Benchmark Master Benchmark %
Create Realm 488.4±20.53µs 489.4±14.07µs 100%
Expression (Parser) 3.6±0.09µs 3.6±0.18µs 100%
Hello World (Execution) 503.2±17.05µs 513.5±31.04µs 98%
Hello World (Lexer) 1176.1±32.30ns 1189.6±45.13ns 99%
Hello World (Parser) 1316.5±56.80ns 1278.3±59.98ns 103%
Symbol Creation 606.3±22.16µs 611.8±26.09µs 99%
fibonacci (Execution) 5.6±0.13ms 5.7±0.12ms 99%
undefined undefined 100%

@github-actions
Copy link

github-actions bot commented Apr 9, 2020

Benchmark for d4f095f

Click to view benchmark
Test PR Benchmark Master Benchmark %
Create Realm 426.2±17.27µs 439.3±26.88µs 97%
Expression (Parser) 3.0±0.15µs 3.1±0.17µs 97%
Hello World (Execution) 434.0±19.42µs 464.5±23.99µs 93%
Hello World (Lexer) 981.3±51.34ns 967.1±47.15ns 101%
Hello World (Parser) 1169.9±53.11ns 1143.8±80.35ns 102%
Symbol Creation 526.9±29.26µs 546.1±40.16µs 96%
fibonacci (Execution) 4.9±0.17ms 5.2±0.21ms 94%
undefined undefined 100%

@Razican Razican merged commit 48ab045 into master Apr 11, 2020
@Razican Razican deleted the contrib_docs branch April 11, 2020 18:33
@jasonwilliams
Copy link
Member

Thanks!

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.

None yet

2 participants