Improve the contributing guide #187
Merged
+187
−47
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
The goal of the change is making contributing to BotD simpler to outside contributors. The updated contributing guide tells how one can help the project, and specifies requirements for outside contributions.
|
Finesse
commented
Oct 22, 2024
|
|
||
| ### Helping with existing issues | ||
|
|
||
| If you want to help, but don't know where to start, take a look at the ["help wanted" issues](https://github.com/fingerprintjs/BotD/labels/help%20wanted). |
| yarn check:ssr | ||
| ``` | ||
|
|
||
| ### How to add a bot detector |
There was a problem hiding this comment.
@xnerhu Please check this section for correctness and completeness. It should give outside contributors all information necessary for creating a new bot detector.
There was a problem hiding this comment.
Looks good, but I would also mention src\utils\browser.ts for checking browser kind, engine ect
There was a problem hiding this comment.
Could you please push a commit with this note?
There was a problem hiding this comment.
Or type it in the comments, I'll add it
There was a problem hiding this comment.
I added it, feel free to modify it if needed
There was a problem hiding this comment.
I've reworder the paragraph, please take a look. I'll add the same paragraph to the FingerprintJS's contributing guide.
xnerhu
approved these changes
Oct 24, 2024
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.
The goal of the change is making contributing to BotD simpler to outside contributors. The updated contributing guide tells how one can help the project, and specifies requirements for outside contributions.
The PR adapts the recent changes to the FingerprintJS's contributing guide for BotD.
The BotD contributing guide was outdated because it implied a client-server architecture that was used in BotD v0. The PR removes all mentions of the server API.