-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #28 from mostypc123/find_jumptoline_highlightselected
v4.1.0
- Loading branch information
Showing
3 changed files
with
144 additions
and
14 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,62 @@ | ||
### Contributing | ||
# Contributing | ||
|
||
## How to Contribute | ||
To contribute: | ||
- Create a fork of the repository. Name it ```fork-XediX```, ```XediX-fork```, ```XediX-forked``` or something similar, but **not** ```XediX```. | ||
- Then, you can make changes in the fork. | ||
- Write a pull request, with a description that is as much detailed as you can. You are allowed to use AI for the description, **but it should be clear and true**. | ||
- If you think it is a high priority PR, write @mostypc123 somwhere in the description. | ||
- Create a fork of the repository. Name it with a variation like ```fork-XediX```, ```XediX-fork```, ```XediX-forked```, but **not** ```XediX```. | ||
- Make your changes in the forked repository. | ||
- Write a pull request with a description that is **at least 20 characters long**. | ||
- If the description is too short, the PR review process will fail. | ||
- You are allowed to use AI for the description, but it must be clear and true. | ||
- If your PR is a work in progress, prefix the title with ```[WIP]``` to skip the review process. | ||
- If you believe this is a high-priority PR or a bug fix, mention @mostypc123 somewhere in the description. | ||
|
||
## PR Guidelines | ||
- Aim to modify fewer than 20 files in a single PR. | ||
- If your PR involves breaking changes, explicitly mention "breaking change" in the description. | ||
|
||
## PR Review Process | ||
- We use a GitHub Action for automated PR reviews. | ||
- The action checks: | ||
- PR description length | ||
- Number of modified files | ||
- Automatic labeling based on description content | ||
- PRs prefixed with ```[WIP]``` will automatically bypass the review process. | ||
|
||
## Frequently Asked Questions | ||
|
||
### Where is the source code? | ||
You can find the source code in the `src/` folder. | ||
|
||
### Can I use AI to help me write code? | ||
Yes, but ensure that: | ||
- You understand and can explain the code you're submitting | ||
- You give appropriate credit if using AI-generated code | ||
|
||
### What coding standards should I follow? | ||
No formal coding standards are established yet. Generally: | ||
- Write clean, readable code | ||
- Add comments where necessary | ||
- Follow common best practices for the language you're using | ||
|
||
### How do I report a bug? | ||
Open an issue in the GitHub repository with: | ||
- A clear, descriptive title | ||
- Steps to reproduce the bug | ||
- Expected vs. actual behavior | ||
- Any relevant error messages or screenshots | ||
|
||
### Can I suggest new features? | ||
Absolutely! Open an issue describing: | ||
- The feature you're proposing | ||
- Why you think it would be valuable | ||
- Any initial thoughts on implementation | ||
|
||
### How long does it take for a PR to be reviewed? | ||
Review times vary. Our GitHub Action provides initial automated checks, and maintainers will review the PR afterward. | ||
|
||
### FAQ | ||
**Where is the source code?** | ||
You can find it in the src/ folder. | ||
### I'm new to open source. How can I contribute? | ||
- Read these guidelines carefully | ||
- Start with small, manageable contributions | ||
- Don't be afraid to ask questions in the issues | ||
|
||
_Nothing else yet. Want to ask a question? Ask in Issues._ | ||
*Have a question not answered here? Open an issue and ask.* |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,3 +5,4 @@ json | |
markdown | ||
pyperclip | ||
psutil | ||
webbrowser |