Link to Contributor's Guide from README + expand Maintainer's Guide (#1071)

filmaj · web-flow · commit 6f369e41565b · 2021-07-28T15:38:41.000+09:00
* Link to Contributor Guide from README. Expand Maintainer Guide with more details on virtual env setup. Mirror Maintainer Guide steps as closely to CI execution as possible. (#1070) * Remove env var prefixing from test run command
diff --git a/.github/contributing.md b/.github/contributing.md
@@ -39,7 +39,7 @@ Issues labelled `good first contribution`.
 For your contribution to be accepted:
 
 - [x] You must have signed the [Contributor License Agreement (CLA)](https://cla-assistant.io/slackapi/python-slack-sdk).
-- [x] The test suite must be complete and pass.
+- [x] The test suite must be complete and pass (see the [Maintainer's Guide](./maintainers_guide.md) for details on how to run the tests).
 - [x] The changes must be approved by code review.
 - [x] Commits should be atomic and messages must be descriptive. Related issues should be mentioned by Issue number.
 
diff --git a/.github/maintainers_guide.md b/.github/maintainers_guide.md
@@ -15,30 +15,48 @@ $ brew update
 $ brew install pyenv
 ```
 
-Install necessary Python runtimes for development/testing. You can rely on Travis CI builds for testing with various major versions. https://github.com/slackapi/python-slack-sdk/blob/main/.travis.yml
+You can hook `pyenv` into your shell automatically by running `pyenv init` and following the instructions.
+
+Install necessary Python runtimes for development/testing. It is not necessary
+to install all the various Python versions we test in [continuous integration on
+GitHub Actions](https://github.com/slackapi/python-slack-sdk/blob/main/.github/workflows/ci-build.yml),
+but make sure you are running at least one version that we execute our tests in
+locally so that you can run the tests yourself.
 
 ```bash
 $ pyenv install -l | grep -v "-e[conda|stackless|pypy]"
 
-$ pyenv install 3.8.5 # select the latest patch version
-$ pyenv local 3.8.5
+$ pyenv install 3.9.6 # select the latest patch version
+$ pyenv local 3.9.6
 
 $ pyenv versions
   system
   3.6.10
   3.7.7
-* 3.8.5 (set by /path-to-python-slack-sdk/.python-version)
+* 3.9.6 (set by /path-to-python-slack-sdk/.python-version)
 
 $ pyenv rehash
 ```
 
-Then, you can create a new Virtual Environment this way:
+Then, you can create a new [Virtual Environment](https://docs.python.org/3/tutorial/venv.html) specific to the Python version you just installed by running:
 
 ```
-$ python -m venv env_3.8.5
-$ source env_3.8.5/bin/activate
+$ python -m venv env_3.9.6
+$ source env_3.9.6/bin/activate
 ```
 
+At this point you have a clean, Python-version-specific environment "activated" for
+use just for this project. All `python` and `pip` commands run in your shell
+from this point on run in the context of this virtual environment. You can
+deactivate the virtual environment by running `deactivate`; it is recommended to
+do so after you are done working in this project. To come back to development
+work for this project again in the future, `cd` into this project directory and
+run `source env_3.9.6/bin/activate` again.
+
+The last step is to install this project's dependencies; to do so, check out [how
+we configure GitHub Actions to install dependencies for this project for use in
+our continuous integration](https://github.com/slackapi/python-slack-sdk/blob/main/.github/workflows/ci-build.yml#L26-L30). You can also run `./scripts/run_validation.sh` to install the dependencies and run the unit tests in one command!
+
 ## Tasks
 
 ### Testing (Unit Tests)
@@ -53,7 +71,7 @@ python setup.py validate \
   --test-target tests/web/test_web_client.py
 ```
 
-You can rely on Travis CI builds for running the tests on a variety of Python runtimes.
+You can rely on GitHub Actions builds for running the tests on a variety of Python runtimes.
 
 ### Testing (Integration Tests with Real Slack APIs)
 
diff --git a/.travis.yml b/.travis.yml
diff --git a/README.md b/README.md
@@ -48,6 +48,7 @@ Are you looking for [slackclient](https://pypi.org/project/slackclient/)? The we
   * [Example](#example)
 * [Migrating from v1](#migrating-from-v1)
 * [Support](#support)
+* [Development](#development)
 
 ### Requirements
 
@@ -138,7 +139,7 @@ except SlackApiError as e:
 
 #### AsyncWebClient in a script
 
-```python 
+```python
 import asyncio
 import os
 from slack_sdk.web.async_client import AsyncWebClient
@@ -266,6 +267,12 @@ If you get stuck, we’re here to help. The following are the best ways to get a
 Use our [Github Issue Tracker][gh-issues] for reporting bugs or requesting features.
 Visit the [Slack Community][slack-community] for getting help using Slack Developer Kit for Python or just generally bond with your fellow Slack developers.
 
+### Contributing
+
+We welcome contributions from everyone! Please check out our
+[Contributor's Guide](.github/contributing.md) for how to contribute in a
+helpful and collaborative way.
+
 <!-- Markdown links -->
 
 [pypi-image]: https://badge.fury.io/py/slack-sdk.svg
