mirror of
https://github.com/tiennm99/serena.git
synced 2026-10-13 04:15:11 +00:00
Add instructions on submitting PRs
This commit is contained in:
1 parent
c89b0d1942
commit
0d8d5add9d
4 files changed
+24
No files matched your search
@@ -0,0 +1,4 @@
|
||||
## Checklist
|
||||
|
||||
- [ ] This PR follows the guidelines in `CONTRIBUTING.md` regarding the scope of PRs.
|
||||
- [ ] For changes that add features or fix problems, I have added an entry to `CHANGELOG.md`, which concisely describes the change.
|
||||
@@ -0,0 +1,11 @@
|
||||
# Creating Pull Requests
|
||||
|
||||
* Make sure the instructions in `CONTRIBUTING.md` regarding the scope of PRs
|
||||
are followed.
|
||||
* For changes that add features or fix problems,
|
||||
add an entry to `CHANGELOG.md` which *concisely* describes the change.
|
||||
Note that details/background information on the change should be in the commit
|
||||
message, not in the changelog.
|
||||
Make sure to follow the existing format and to add your change to the
|
||||
appropriate section.
|
||||
|
||||
@@ -73,6 +73,9 @@ initial_prompt: |
|
||||
Comments:
|
||||
When describing parameters, methods/functions and classes, you use a precise style, where the initial (elliptical) phrase
|
||||
clearly defines *what* it is. Any details then follow in subsequent sentences.
|
||||
|
||||
Pull requests:
|
||||
Read `mem:creating_pull_requests` when asked to participate in the creation of a pull request.
|
||||
|
||||
# the encoding used by text files in the project
|
||||
# For a list of possible encodings, see https://docs.python.org/3.11/library/codecs.html#standard-encodings
|
||||
|
||||
@@ -18,6 +18,12 @@ Every PR should cover a single logical change or a set of closely related change
|
||||
|
||||
See the corresponding [memory](.serena/memories/adding_new_language_support_guide.md).
|
||||
|
||||
## Submitting Pull Requests
|
||||
|
||||
Before submitting a PR, be sure to document your relevant changes (i.e. new features, fixes) in `CHANGELOG.md`.
|
||||
Use a concise style and add your change to the appropriate section
|
||||
("Language Servers", "Tools", "JetBrains", "CLI", "Memories", "Dashboard", "Hooks", "General").
|
||||
|
||||
## Python Environment Setup
|
||||
|
||||
You can install a virtual environment with the required as follows
|
||||
|
||||
Reference in new issue
Block a user