diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4c11d1fdfd..0acc8bfc6a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -52,33 +52,35 @@ Running from source ------------------- Sopel is your typical Python project: you can install it from source, edit -the code using standard tooling, and take advantage of your favourite code +the code using standard tooling, and take advantage of your favorite code editor. Assuming you are using standard tools: -* Create a virtualenv; you can use `virtualenv` directly, `virtualenvwrapper`, - or any tools that allows you to create and manage your virtualenv. +* Create a virtualenv. + * You can use `virtualenv` directly, `virtualenvwrapper`, or any tool that + allows you to create and manage your virtualenv. * Fork Sopel's repository, and clone your fork locally. * Activate your virtualenv, and `cd` into your clone's folder. * Ensure you have the latest version of `pip`, and install `wheel`. -* Install Sopel from source as an editable install. If you don't use a project - manager (like Poetry or Hatch), you can do that with `pip install -e .` from - within the clone's directory, where there is a `pyproject.toml` file. -* Install developments tools used to run tests and linters; there is a specific +* Install Sopel from source as an editable install. + * If you don't use a project manager (like Poetry or Hatch), you can do + that with `pip install -e .` from within the clone's directory, where + there is a `pyproject.toml` file. +* Install development tools used to run tests and linters; there is a specific requirement file you can use with `pip install -U -r dev-requirements.txt`. * Run `make qa` to run linters and tests. * Run `make cleandoc` or just `make docs` to build the documentation locally. -At this point, you are all set (at least for the Python environment), all -that's left to you is to configure your code editor the way you like, read and +At this point, you are all set, at least for the Python environment; all +that's left is for you to configure your code editor the way you like, and read and write some code and documentation. -Using branch ------------- +Using branches +-------------- As previously stated, you should fork Sopel's repository to implement your -change and commits them. Moreover, we advise you to work from your own branch. +changes and commit them. Moreover, we advise you to work from your own branch. To setup your local clone, we suggest the following steps: @@ -108,7 +110,7 @@ $ git push If you never pushed on your own `master` branch, you should not need to force the push, which is why we recommend to work on your own branch. -Said working can be updated with rebase: +Said branch can be updated with rebase: ``` $ git checkout