Skip to content

Commit 642279f

Browse files
remote-swe-userremote-swe-app[bot]
and
remote-swe-app[bot]
authored
Improve README.md with clearer instructions (#28)
This PR addresses issue #27 with the following improvements to the README.md: 1. Added clarification that Bedrock Claude Sonnet 3.7 model needs to be enabled in both us-east-1 and us-west-2 regions 2. Added 'proceed to next step' instructions at the end of each numbered step to improve user flow 3. Added guidance on when to use Personal Access Token vs GitHub App for GitHub integration 4. Enhanced overall readability with clearer instructions throughout the setup process Fixes #27 Co-authored-by: remote-swe-app[bot] <123456+remote-swe-app[bot]@users.noreply.github.com>
1 parent 1070cae commit 642279f

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

README.md

+19-3
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Please carefully follow all the steps below. If you encounter any issues, we're
2525
- npm (version 9 or higher)
2626
- AWS CLI
2727
- AWS IAM profile with appropriate permissions
28-
- Bedrock Claude Sonnet 3.7 model is [enabled on](https://docs.aws.amazon.com/bedrock/latest/userguide/getting-started.html#getting-started-model-access) US region
28+
- Bedrock Claude Sonnet 3.7 model is [enabled on](https://docs.aws.amazon.com/bedrock/latest/userguide/getting-started.html#getting-started-model-access) both us-east-1 and us-west-2 regions
2929
- Slack Workspace
3030
- GitHub Account
3131

@@ -36,6 +36,8 @@ git clone https://github.com/aws-samples/remote-swe-agents.git
3636
cd remote-swe-agents
3737
```
3838

39+
After completing this step, proceed to Step 2 to set up the required parameters and deploy the CDK stack.
40+
3941
### 2. Run CDK Deploy
4042

4143
Before running cdk deploy, you need to create placeholder SSM parameters that will later be populated with actual values:
@@ -65,7 +67,9 @@ npx cdk bootstrap
6567
npx cdk deploy
6668
```
6769

68-
Deployment usually takes about 5 minutes. After the deployment, you should see the endpoint of your Slack Bolt app. Please continue to the next step.
70+
Deployment usually takes about 5 minutes. After the deployment, you should see the endpoint of your Slack Bolt app. Make note of the `SlackBoltEndpointUrl` from the CDK output as you'll need it in the next step.
71+
72+
After completing this step, proceed to Step 3 to set up your Slack application.
6973

7074
### 3. Slack App Setup
7175

@@ -109,11 +113,17 @@ aws ssm put-parameter \
109113

110114
Replace `your-slack-bot-token` and `your-slack-signing-secret` with the actual values you obtained in the previous step. The parameters will be referenced from CDK.
111115

116+
After completing this step, proceed to Step 4 to set up GitHub integration. You will need to choose between using a Personal Access Token (PAT) or GitHub App for authentication.
117+
112118

113119
### 4. GitHub Integration
114120

115121
To interact with GitHub, you need to setup GitHub integration. You have two options for GitHub integration:
116122

123+
**Which option should you choose?**
124+
- **Personal Access Token (Option 1)**: Choose this for personal use or quick setup. It's simpler but tied to a single user account.
125+
- **GitHub App (Option 2)**: Recommended for team environments or organizational use. Provides more granular permissions and isn't tied to a personal account.
126+
117127
#### Option 1: Personal Access Token (PAT)
118128

119129
1. Go to [GitHub Settings > Developer settings > Personal access tokens](https://github.com/settings/tokens)
@@ -150,6 +160,8 @@ To interact with GitHub, you need to setup GitHub integration. You have two opti
150160
> [!NOTE]
151161
> Currently when using with GitHub App, you can only use repositories under a single organization (i.e. app installation).
152162
163+
After completing this step, proceed to Step 5 to set up environment variables based on your chosen GitHub integration method.
164+
153165
### 5. Environment Variables Setup
154166

155167
The following environment variables are required for deployment:
@@ -181,6 +193,8 @@ All users except those with specified user IDs will receive an Unauthorized erro
181193
> [!NOTE]
182194
> To grant a user access to the app, mention the app with an `approve_user` message followed by mentions of the users, e.g., `@remote-swe approve_user @Alice @Bob @Carol`
183195
196+
After completing this step, proceed to Step 6 to finalize the deployment with your configuration.
197+
184198
### 6. Deploy CDK again with configuration variables
185199

186200
After the above setup is complete, run `cdk deploy` again.
@@ -190,7 +204,9 @@ cd cdk
190204
npx cdk deploy
191205
```
192206

193-
You can now access all features from Slack. Simply mention the Slack app and start assigning tasks to the agents!
207+
Congratulations! Setup is now complete. You can now access all features from Slack. Simply mention the Slack app and start assigning tasks to the agents!
208+
209+
For tips on how to effectively use the agents, refer to the "Useful Tips" section below.
194210

195211
## Useful Tips
196212

0 commit comments

Comments
 (0)