Skip to content

Commit cb523a7

Browse files
Burak Bayırkriptoburak
andauthored
docs: enforce source LOC reduction (#56)
Signed-off-by: kriptoburak <kriptoburak@users.noreply.github.com> Co-authored-by: kriptoburak <kriptoburak@users.noreply.github.com>
1 parent 6d92989 commit cb523a7

2 files changed

Lines changed: 16 additions & 17 deletions

File tree

AGENTS.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Agent instructions
2+
3+
Each commit must reduce net handwritten source LOC. No exceptions. No one may waive this rule.
4+
Additions require larger, useful simplifications elsewhere in this repository.
5+
Formatting, minification, generated files, and deleted valuable tests or docs do not count.

CONTRIBUTING.md

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# Contributing
22

3+
Follow the shared [Xquik contribution policy][contribution-policy].
4+
35
## Set up
46

5-
The `.ruby-version` file works with rbenv and asdf's Ruby plugin.
6-
Install that Ruby version, then run:
7+
Install `.ruby-version` through rbenv or asdf, then run:
78

89
```bash
910
./scripts/bootstrap
@@ -13,8 +14,7 @@ Run `bundle exec rake` to list every task.
1314

1415
## Generated code
1516

16-
Most SDK files come from the API generator.
17-
Direct edits survive regeneration but can create conflicts.
17+
The API generator owns most SDK files. Direct edits can conflict later.
1818
The generator never changes `lib/x_twitter_scraper/helpers/` or `examples/`.
1919

2020
## Add examples
@@ -37,15 +37,12 @@ ruby examples/<name>.rb
3737

3838
## Use a source checkout
3939

40-
Reference GitHub in your `Gemfile`:
40+
Reference GitHub or a local clone in your `Gemfile`:
4141

4242
```ruby
43+
# GitHub
4344
gem "x-twitter-scraper", git: "https://github.com/Xquik-dev/x-twitter-scraper-ruby"
44-
```
45-
46-
Reference a local clone instead:
47-
48-
```ruby
45+
# Local clone
4946
gem "x-twitter-scraper", path: "<path-to-repo>"
5047
```
5148

@@ -62,11 +59,8 @@ bundle exec rake docs:preview PORT=8808
6259

6360
## Editor support
6461

65-
Install Ruby LSP for definition lookup and Solargraph for completion.
66-
67-
Sorbet works here with 2 known caveats:
68-
69-
- Definition lookup can select the wrong declaration.
70-
- Generic RBI types can report duplicate type members.
62+
Use Ruby LSP for definitions and Solargraph for completion. Sorbet may select
63+
the wrong declaration or report duplicate generic RBI members. Neither warning
64+
affects downstream gem users.
7165

72-
These warnings do not affect downstream gem users.
66+
[contribution-policy]: https://github.com/Xquik-dev/.github/blob/main/CONTRIBUTING.md

0 commit comments

Comments
 (0)