Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 17 additions & 19 deletions .github/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,47 +9,45 @@ efforts to help improve ServSpy.

Before contributing:
--------------------
1, Before you start to contribute, especially open a pull request.
Please make sure that you already opened an issue to discuss
the changes you want to make. This will help us understand
your intentions and provide feedback before you start working
on the code, tests or docs etc., or your PR may be closed
without review. In addition, please add the issue number
or the url in the description of your pull request, so we
can easily track the related issue and PR.
1. Before you start to contribute, especially before opening a pull request,
please make sure that you have already opened an issue to discuss the
changes you want to make. This will help us understand your intentions and
provide feedback before you start working on the code, tests or docs etc.,
or your PR may be closed without review. In addition, please add the issue
number or the URL in the description of your pull request, so we can easily
track the related issue and PR.

2, Please make sure that you have already made a fork repository
of ServSpy.
2. Please make sure that you have already forked the ServSpy
repository.

3, After you made a fork repository, please clone it to your local:
3. After you have forked the repository, please clone it to your local machine:

.. code-block:: bash

git clone https://github.com/<your-username>/ServSpy.git
cd ./ServSpy

4, If there are any new commits ahead of your fork repository,
please pull the latest changes from the original repository to
avoid the merge conflicts:
4. If there are new commits in the upstream repository that your fork
does not have, please pull the latest changes to avoid merge conflicts:

.. code-block:: bash

git pull origin main --rebase

5, Create a new branch for your changes
(Make sure the branch name is descriptive of the changes you are making):
5. Create a new branch for your changes
(Make sure the branch name is descriptive of the changes you are making):

.. code-block:: bash

git checkout -b <your-branch-name>

6, When you have made your changes, commit and push them with a clear
and descriptive commit message:
6. When you have made your changes, commit and push them with a clear
and descriptive commit message:

.. code-block:: bash

git add <changed-files>
git commit -m "Describe your changes here"
git push origin <your-branch-name>

7, Finally, open a pull request to the original repository.
7. Finally, open a pull request to the original repository.
12 changes: 6 additions & 6 deletions docs/Network_APIs/TCP_Client_APIs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ The TCP Client Setup API will initialize all the necessary
parameters and resources for the TCP client.

*Note: In the main class of the TCP client setup API,
we initialize the `start_TCP_client` method to setup
we initialize the `start_TCP_client` method to set up
all functions which are needed in the TCP client,
including connecting to the server, handling incoming
messages, and managing user input.*
Expand Down Expand Up @@ -100,10 +100,10 @@ will read user input from the console and send messages
to the server until the connection is closed.

*Note: There is a global variable ``self.running``
which is turned to ``True`` after the client successfully
which is set to ``True`` after the client successfully
connects to the server. The ``self.running`` variable is
used to control the main receive loop, and it will be
turned to ``False`` when the client is shutting down.*
set to ``False`` when the client is shutting down.*

The `connect` method will try to establish a TCP connection
to the server. If a ``client_port`` is specified, the client
Expand Down Expand Up @@ -185,7 +185,7 @@ connection and is responsible for:
In `handle_server_command`, the client processes built-in
commands sent by the server, such as:

- ``/client_alloc_port_range``: configures the clients manual
- ``/client_alloc_port_range``: configures the client's manual
port allocation range based on server broadcast.
- ``/server_file_transfer_port``: receives the file transfer
port assigned by the server for an ongoing file operation.
Expand Down Expand Up @@ -590,8 +590,8 @@ controlled (e.g., firewalls or testing).
TCP Client APIs table
---------------------

In short, the table of contents of the public APIs
are as follows:
In short, the table of contents of the public APIs
is as follows:

1. The client setup APIs:
- `TCP_Client_Base`
Expand Down
Loading
Loading