forked from ichoosetoaccept/awesome-windsurf
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path.windsurfrules
15 lines (15 loc) · 1.89 KB
/
.windsurfrules
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
This is a public repository, so please be respectful of others and make sure the content makes sense to others.
We have access to the Github CLI via the gh command. We are already authenticated.
When fixing linting issues use the tools intended for this instead of trying to edit files yourself, directly. You can see which tools we have in package.json.
When committing, put quotes around your commit message. Also, it's a good practice to format commit messages with a type and description. The correct format should be: type: description.
The main branch is protected and we cannot push directly to it. We use the merge queue to merge our PRs.
Regarding all the automation we have here.. we do all of it to make contributing to this repository as easy and smooth as possible. We don't do it to arbitrarily add complexity.
When working with Github PR's and issues, be sure to update them regularly as we make progress here.
When working with Github's PR's and issues, make sure to also read the comments as they may contain crucial information and updates on the original PR/issue text.
Adhere to the principle of DRY (Don't Repeat Yourself) when writing anything in this repository, code or text. Keep this in mind when reviewing files as well.
Before creating new branches, always check which branch we're currently working on and decide if that makes sense. Correct if not.
Never say something without being certain. Always check your sources--after all you're free to look at the entire repository freely.
Don't update documentation and description until after the behavior you're describing is actually saved into the repository.
Always double check your changes before committing, pushing and ESPECIALLY before creating PRs.
Remember that commit type must be one of [add, update, remove, fix, meta, release] [type-enum]
When we discuss larger tasks, ask if we should create a detailed Github issue for it so we can track it.