Developers Contributing Guide

This guide will walk through the code contribution guide, we expect you have a github account and experience using git and familiarity with GitHub interface.

GitHub Account

If you don’t have a GitHub account please register your account.

Fork the repo

First, you’ll need to fork the repo https://github.com/buildtesters/buildtest

You might need to setup your SSH keys in your git profile if you are using ssh option for cloning. For more details on setting up SSH keys in your profile, follow instruction found in https://help.github.com/articles/connecting-to-github-with-ssh/

SSH key will help you pull and push to repository without requesting for password for every commit. Once you have forked the repo, clone your local repo:

git clone git@github.com:YOUR\_GITHUB\_LOGIN/buildtest.git

Adding Upstream Remote

First you need to add the upstream repo, to do this you can issue the following:

git remote add upstream git@github.com/buildtesters/buildtest.git

The upstream tag is used to sync changes from upstream repo to keep your repo in sync before you contribute back.

Make sure you have set your user name and email set properly in git configuration. We don’t want commits from unknown users. This can be done by setting the following:

git config user.name "First Last"
git config user.email "abc@example.com"

For more details see First Time Git Setup

Sync your branch from upstream

The devel from upstream will get Pull Requests from other contributors, in-order to sync your forked repo with upstream, run the commands below:

git checkout devel
git fetch upstream devel
git pull upstream devel

Once the changes are pulled locally you can sync devel branch with your fork as follows:

git checkout devel
git push origin devel

Repeat this same operation with master branch if you want to sync it with upstream repo

Contribution Workflow

If you want to contribute back, you should create a feature branch from devel and add your files, commit and push them to your fork. The workflow can be summarized as follows:

git checkout devel
git checkout -b featureX
git add <file1> <file2> ...
git commit -m "commit message"
git push origin featureX

Once the branch is created in your fork, you can create a Pull Request with the destination branch devel at https://github.com/buildtesters/buildtest and base branch which is your feature branch pushed at your fork.

Note

Do not push to master or devel branch on your fork or upstream.

Pull Request Review

Once you have submitted a Pull Request, please check the automated checks that are run for your PR to ensure checks are passed. Most common failures in CI checks are black and pyflakes issue, this can be done by configuring black and running pyflakes. Once all checks have passed, maintainer will review your PR and provide feedback so please be patient. Please coordinate with maintainer through PR or Slack.

Resolving PR Merge Conflicts

Often times, you may start a feature branch and your PR get’s out of sync with devel branch which may lead to conflicts, this is a result of merging incoming PRs that may cause upstream HEAD to change over time which can cause merge conflicts. This may be confusing at first, but don’t worry we are here to help. For more details about merge conflicts click here.

Syncing your feature branch with devel is out of scope for this documentation, however you can use the steps below as a guide when you run into this issue.

You may want to take the steps to first sync devel branch and then selectively rebase or merge devel into your feature branch.

First go to devel branch and fetch changes from upstream:

git checkout devel
git fetch upstream devel

Note you shouldn’t be making any changes to your local devel branch, if git fetch was successful you can merge your devel with upstream as follows:

git merge upstream/devel

Next, navigate to your feature branch and sync feature changes with devel:

git checkout <feature-branch>
git merge devel

Note

Running above command will sync your feature branch with devel but you may have some file conflicts depending on files changed during PR. You will need to resolve them manually before pushing your changes

Instead of merge from devel you can rebase your commits interactively when syncing with devel. This can be done by running:

git rebase -i devel

Once you have synced your branch push your changes and check if file conflicts are resolved in your Pull Request:

git push origin <feature-branch>

General Tips

1. It’s good practice to link PR to an issue during commit message. Such as stating Fix #132 for fixing issue 132.

2. If you have an issue, ask your question in slack before reporting issue. If your issue is not resolved check any open issues for resolution before creating a new issue.

3. For new features or significant code refactor please notify maintainers and open an issue before working on task to keep everyone informed.

4. If you open an issue, please respond back during discussion, if there is no activity the issue will be closed.

5. Please refrain from opening duplicate issue, check if there is an existing issue addressing similar problem, instead you can participate in discussion in the issue or contact appropriate individuals directly in slack.

6. There should not be any branches other than master or devel. Feature branches should be pushed to your fork and not to origin.

Configuring Black Pre-Commit Hook

To configure pre-commit hook, make sure you install pre-commit via pip install pre-commit. The pre-commit utility should be available if you install extra dependencies from buildtest (pip install -r docs/requirements.txt).

You can configure .pre-commit-config.yaml with the version of python you are using. It is currently setup to run for python 3.7 version as follows:

language_version: python3.7

Alter this value based on python version you are using or refer to black version control integration.

To install the pre-commit hook run:

$ pre-commit install
pre-commit installed at .git/hooks/pre-commit

This will invoke hook .git/hooks/pre-commit prior to git commit. Shown below we attempt to commit which resulted in pre commit hook and caused black to format code.

$ git commit -m "test black commit with precommit"
black....................................................................Failed
- hook id: black
- files were modified by this hook

reformatted buildtest/config.py
All done! ✨ 🍰 ✨
1 file reformatted.

If you are interested in running black locally to see diff result from black without auto-formatting code, you can do the following:

$ black --check --diff .
--- tests/test_inspect.py       2020-02-25 18:58:58.360360 +0000
+++ tests/test_inspect.py       2020-02-25 18:59:07.336414 +0000
@@ -18,11 +18,11 @@
 def test_distro_short():
     assert "rhel" == distro_short("Red Hat Enterprise Linux Server")
     assert "centos" == distro_short("CentOS")
     assert "suse" == distro_short("SUSE Linux Enterprise Server")
-    x=0+1*3
+    x = 0 + 1 * 3

The changes will be shown with lines removed or added via - and +. For more details refer to black documentation.

isort

isort is a python utility that will sort python imports alphabetically. We use isort as part of the CI checks, there is a .isort.cfg that defines the isort configuration that is compatible with black utility. We have setup a pre-commit hook that can be used to automatically run isort as part of your git commit process. This is defined in pre-commit configuration file .pre-commit-config.yaml that can be installed by running pre-commit install. Once this is setup, you will see isort and black checks are run during the commit process.

$ git commit
isort....................................................................Passed
black....................................................................Passed
[sphinx_fix 85d9d42c] fix issue with rendering bullet points in sphinx. This is solved by downgrading docutils to version 0.16.
 2 files changed, 5 insertions(+)

If you want to run isort, you can use the -c and –diff option to check and see diff between files. For instance in example below we see isort reports changes to import statement

$ isort -c --diff profile black  buildtest/main.py
ERROR: /Users/siddiq90/Documents/GitHubDesktop/buildtest/buildtest/main.py Imports are incorrectly sorted and/or formatted.
--- /Users/siddiq90/Documents/GitHubDesktop/buildtest/buildtest/main.py:before      2021-07-13 16:53:42.722718
+++ /Users/siddiq90/Documents/GitHubDesktop/buildtest/buildtest/main.py:after       2021-07-13 16:54:12.135986
@@ -1,8 +1,7 @@
 """Entry point for buildtest"""

+import os
 import webbrowser
-import os
-

 from buildtest.cli import get_parser
 from buildtest.cli.build import BuildTest
Broken 2 paths

If you want to apply the changes you can get rid of -c and --diff option and isort will apply the changes. Please see https://pycqa.github.io/isort/docs/configuration/black_compatibility.html and https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html#isort for documentation regarding black and isort compatibility.

pyflakes

pyflakes is a program that checks for python source code for errors such as unused imports. We have configured an automated check to test your incoming PR using pyflakes. pyflakes should be available in your python environment if you installed buildtest extra dependencies in requirements.txt (pip install -r docs/requirements.txt).

You can run pyflakes against any file or directory the ones of importance is running pyflakes against buildtest source code and regression test. You can do that by running:

pyflakes buildtest tests

Running stylechecks via buildtest stylecheck

The buildtest stylecheck command can run the stylechecks such as black, isort, pyflakes which can should be used before you commit your changes. Shown below are the available options for buildtest stylecheck

$ buildtest stylecheck --help
usage: buildtest [options] [COMMANDS] stylecheck [-h] [--no-black]
                                                 [--no-isort] [--no-pyflakes]
                                                 [-a]

optional arguments:
  -h, --help     show this help message and exit
  --no-black     Don't run black style check
  --no-isort     Don't run isort style check
  --no-pyflakes  Dont' run pyflakes check
  -a, --apply    Apply style checks to codebase.

Note

buildtest style is an alias for buildtest stylecheck

By default, all the checks are run when no options are specified however if you want to disable a particular style check you can specify on command line such as --no-black will disable black style check.

Shown below is an example output of what style check will report. By default, black and isort will report changes that will need to be fixed, if you want to apply those changes to buildtest codebase you can pass the --apply option.

buildtest stylecheck
$ buildtest stylecheck
Running black check: black --check --diff /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/devel/buildtest /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/devel/tests /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/devel/docs
black style check FAILED
───────────────────────────── black output message ─────────────────────────────
--- /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/devel/docs/conf.py     2022-10-07 18:34:55.191707 +0000
+++ /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/devel/docs/conf.py     2022-10-07 18:35:48.626499 +0000
@@ -252,12 +252,10 @@
 
 # A list of files that should not be packed into the epub file.
 epub_exclude_files = ["search.html"]
 
 
-
-
 ###########################################################################
 #          auto-created readthedocs.org specific configuration            #
 ###########################################################################
 
 
@@ -280,188 +278,190 @@
 from sphinx import version_info
 
 # Get suffix for proper linking to GitHub
 # This is deprecated in Sphinx 1.3+,
 # as each page can have its own suffix
-if globals().get('source_suffix', False):
+if globals().get("source_suffix", False):
     if isinstance(source_suffix, string_types):
         SUFFIX = source_suffix
     elif isinstance(source_suffix, (list, tuple)):
         # Sphinx >= 1.3 supports list/tuple to define multiple suffixes
         SUFFIX = source_suffix[0]
     elif isinstance(source_suffix, dict):
         # Sphinx >= 1.8 supports a mapping dictionary for multiple suffixes
-        SUFFIX = list(source_suffix.keys())[0]  # make a ``list()`` for py2/py3 compatibility
+        SUFFIX = list(source_suffix.keys())[
+            0
+        ]  # make a ``list()`` for py2/py3 compatibility
     else:
         # default to .rst
-        SUFFIX = '.rst'
+        SUFFIX = ".rst"
 else:
-    SUFFIX = '.rst'
+    SUFFIX = ".rst"
 
 # Add RTD Static Path. Add to the end because it overwrites previous files.
-if not 'html_static_path' in globals():
+if not "html_static_path" in globals():
     html_static_path = []
-if os.path.exists('_static'):
-    html_static_path.append('_static')
+if os.path.exists("_static"):
+    html_static_path.append("_static")
 
 # Add RTD Theme only if they aren't overriding it already
 using_rtd_theme = (
-    (
-        'html_theme' in globals() and
-        html_theme in ['default'] and
-        # Allow people to bail with a hack of having an html_style
-        'html_style' not in globals()
-    ) or 'html_theme' not in globals()
-)
+    "html_theme" in globals()
+    and html_theme in ["default"]
+    and
+    # Allow people to bail with a hack of having an html_style
+    "html_style" not in globals()
+) or "html_theme" not in globals()
 if using_rtd_theme:
-    theme = importlib.import_module('sphinx_rtd_theme')
-    html_theme = 'sphinx_rtd_theme'
+    theme = importlib.import_module("sphinx_rtd_theme")
+    html_theme = "sphinx_rtd_theme"
     html_style = None
     html_theme_options = {}
-    if 'html_theme_path' in globals():
+    if "html_theme_path" in globals():
         html_theme_path.append(theme.get_html_theme_path())
     else:
         html_theme_path = 
 
-if globals().get('websupport2_base_url', False):
-    websupport2_base_url = 'https://readthedocs.org/websupport'
-    websupport2_static_url = 'https://assets.readthedocs.org/static/'
-
-
-#Add project information to the template context.
+if globals().get("websupport2_base_url", False):
+    websupport2_base_url = "https://readthedocs.org/websupport"
+    websupport2_static_url = "https://assets.readthedocs.org/static/"
+
+
+# Add project information to the template context.
 context = {
-    'using_theme': using_rtd_theme,
-    'html_theme': html_theme,
-    'current_version': "devel",
-    'version_slug': "devel",
-    'MEDIA_URL': "https://media.readthedocs.org/",
-    'STATIC_URL': "https://assets.readthedocs.org/static/",
-    'PRODUCTION_DOMAIN': "readthedocs.org",
-    'proxied_static_path': "/_/static/",
-    'versions': [
-    ("latest", "/en/latest/"),
-    ("stable", "/en/stable/"),
-    ("v0.15.0", "/en/v0.15.0/"),
-    ("v0.14.0", "/en/v0.14.0/"),
-    ("v0.13.0", "/en/v0.13.0/"),
-    ("v0.12.0", "/en/v0.12.0/"),
-    ("v0.11.0", "/en/v0.11.0/"),
-    ("v0.10.2", "/en/v0.10.2/"),
-    ("v0.10.1", "/en/v0.10.1/"),
-    ("v0.10.0", "/en/v0.10.0/"),
-    ("v0.9.6", "/en/v0.9.6/"),
-    ("v0.9.5", "/en/v0.9.5/"),
-    ("v0.9.4", "/en/v0.9.4/"),
-    ("v0.9.3", "/en/v0.9.3/"),
-    ("v0.9.2", "/en/v0.9.2/"),
-    ("v0.9.1", "/en/v0.9.1/"),
-    ("v0.9.0", "/en/v0.9.0/"),
-    ("v0.8.1", "/en/v0.8.1/"),
-    ("v0.8.0", "/en/v0.8.0/"),
-    ("v0.7.6", "/en/v0.7.6/"),
-    ("devel", "/en/devel/"),
+    "using_theme": using_rtd_theme,
+    "html_theme": html_theme,
+    "current_version": "devel",
+    "version_slug": "devel",
+    "MEDIA_URL": "https://media.readthedocs.org/",
+    "STATIC_URL": "https://assets.readthedocs.org/static/",
+    "PRODUCTION_DOMAIN": "readthedocs.org",
+    "proxied_static_path": "/_/static/",
+    "versions": [
+        ("latest", "/en/latest/"),
+        ("stable", "/en/stable/"),
+        ("v0.15.0", "/en/v0.15.0/"),
+        ("v0.14.0", "/en/v0.14.0/"),
+        ("v0.13.0", "/en/v0.13.0/"),
+        ("v0.12.0", "/en/v0.12.0/"),
+        ("v0.11.0", "/en/v0.11.0/"),
+        ("v0.10.2", "/en/v0.10.2/"),
+        ("v0.10.1", "/en/v0.10.1/"),
+        ("v0.10.0", "/en/v0.10.0/"),
+        ("v0.9.6", "/en/v0.9.6/"),
+        ("v0.9.5", "/en/v0.9.5/"),
+        ("v0.9.4", "/en/v0.9.4/"),
+        ("v0.9.3", "/en/v0.9.3/"),
+        ("v0.9.2", "/en/v0.9.2/"),
+        ("v0.9.1", "/en/v0.9.1/"),
+        ("v0.9.0", "/en/v0.9.0/"),
+        ("v0.8.1", "/en/v0.8.1/"),
+        ("v0.8.0", "/en/v0.8.0/"),
+        ("v0.7.6", "/en/v0.7.6/"),
+        ("devel", "/en/devel/"),
     ],
-    'downloads': [ 
-    ],
-    'subprojects': [ 
-    ],
-    'slug': 'buildtest',
-    'name': u'buildtest',
-    'rtd_language': u'en',
-    'programming_language': u'py',
-    'canonical_url': 'https://buildtest.readthedocs.io/en/devel/',
-    'analytics_code': 'UA-132939465-1',
-    'single_version': False,
-    'conf_py_path': '/docs/',
-    'api_host': 'https://readthedocs.org',
-    'github_user': 'buildtesters',
-    'proxied_api_host': '/_',
-    'github_repo': 'buildtest',
-    'github_version': 'devel',
-    'display_github': True,
-    'bitbucket_user': 'None',
-    'bitbucket_repo': 'None',
-    'bitbucket_version': 'devel',
-    'display_bitbucket': False,
-    'gitlab_user': 'None',
-    'gitlab_repo': 'None',
-    'gitlab_version': 'devel',
-    'display_gitlab': False,
-    'READTHEDOCS': True,
-    'using_theme': (html_theme == "default"),
-    'new_theme': (html_theme == "sphinx_rtd_theme"),
-    'source_suffix': SUFFIX,
-    'ad_free': False,
-    'docsearch_disabled': False,
-    'user_analytics_code': 'UA-132939465-1',
-    'global_analytics_code': 'UA-17997319-1',
-    'commit': '69b02878',
+    "downloads": [],
+    "subprojects": [],
+    "slug": "buildtest",
+    "name": "buildtest",
+    "rtd_language": "en",
+    "programming_language": "py",
+    "canonical_url": "https://buildtest.readthedocs.io/en/devel/",
+    "analytics_code": "UA-132939465-1",
+    "single_version": False,
+    "conf_py_path": "/docs/",
+    "api_host": "https://readthedocs.org",
+    "github_user": "buildtesters",
+    "proxied_api_host": "/_",
+    "github_repo": "buildtest",
+    "github_version": "devel",
+    "display_github": True,
+    "bitbucket_user": "None",
+    "bitbucket_repo": "None",
+    "bitbucket_version": "devel",
+    "display_bitbucket": False,
+    "gitlab_user": "None",
+    "gitlab_repo": "None",
+    "gitlab_version": "devel",
+    "display_gitlab": False,
+    "READTHEDOCS": True,
+    "using_theme": (html_theme == "default"),
+    "new_theme": (html_theme == "sphinx_rtd_theme"),
+    "source_suffix": SUFFIX,
+    "ad_free": False,
+    "docsearch_disabled": False,
+    "user_analytics_code": "UA-132939465-1",
+    "global_analytics_code": "UA-17997319-1",
+    "commit": "69b02878",
 }
 
 # For sphinx >=1.8 we can use html_baseurl to set the canonical URL.
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_baseurl
 if version_info >= (1, 8):
-    if not globals().get('html_baseurl'):
-        html_baseurl = context['canonical_url']
-    context['canonical_url'] = None
-
-
-
-
-
-if 'html_context' in globals():
-    
+    if not globals().get("html_baseurl"):
+        html_baseurl = context["canonical_url"]
+    context["canonical_url"] = None
+
+
+if "html_context" in globals():
+
     html_context.update(context)
-    
+
 else:
     html_context = context
 
 # Add custom RTD extension
-if 'extensions' in globals():
+if "extensions" in globals():
     # Insert at the beginning because it can interfere
     # with other extensions.
     # See https://github.com/rtfd/readthedocs.org/pull/4054
     extensions.insert(0, "readthedocs_ext.readthedocs")
 else:
     extensions = ["readthedocs_ext.readthedocs"]
 
 # Add External version warning banner to the external version documentation
-if 'branch' == 'external':
+if "branch" == "external":
     extensions.insert(1, "readthedocs_ext.external_version_warning")
-    readthedocs_vcs_url = 'None'
-    readthedocs_build_url = 'https://readthedocs.org/projects/buildtest/builds/18279078/'
-
-project_language = 'en'
+    readthedocs_vcs_url = "None"
+    readthedocs_build_url = (
+        "https://readthedocs.org/projects/buildtest/builds/18279078/"
+    )
+
+project_language = "en"
 
 # User's Sphinx configurations
-language_user = globals().get('language', None)
-latex_engine_user = globals().get('latex_engine', None)
-latex_elements_user = globals().get('latex_elements', None)
+language_user = globals().get("language", None)
+latex_engine_user = globals().get("latex_engine", None)
+latex_elements_user = globals().get("latex_elements", None)
 
 # Remove this once xindy gets installed in Docker image and XINDYOPS
 # env variable is supported
 # https://github.com/rtfd/readthedocs-docker-images/pull/98
 latex_use_xindy = False
 
-chinese = any([
-    language_user in ('zh_CN', 'zh_TW'),
-    project_language in ('zh_CN', 'zh_TW'),
-])
-
-japanese = any([
-    language_user == 'ja',
-    project_language == 'ja',
-])
+chinese = any(
+    [
+        language_user in ("zh_CN", "zh_TW"),
+        project_language in ("zh_CN", "zh_TW"),
+    ]
+)
+
+japanese = any(
+    [
+        language_user == "ja",
+        project_language == "ja",
+    ]
+)
 
 if chinese:
-    latex_engine = latex_engine_user or 'xelatex'
+    latex_engine = latex_engine_user or "xelatex"
 
     latex_elements_rtd = {
-        'preamble': '\\usepackage[UTF8]{ctex}\n',
+        "preamble": "\\usepackage[UTF8]{ctex}\n",
     }
     latex_elements = latex_elements_user or latex_elements_rtd
 elif japanese:
-    latex_engine = latex_engine_user or 'platex'
+    latex_engine = latex_engine_user or "platex"
 
 # Make sure our build directory is always excluded
-exclude_patterns = globals().get('exclude_patterns', [])
-exclude_patterns.extend(['_build'])
+exclude_patterns = globals().get("exclude_patterns", [])
+exclude_patterns.extend(["_build"])

───────────────────────────── black error message ──────────────────────────────
would reformat /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/devel/docs/conf.py
Oh no! 💥 💔 💥
1 file would be reformatted, 146 files would be left unchanged.

Running isort check: isort --settings-path /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/devel/.isort.cfg --profile black --check --diff /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/devel/buildtest /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/devel/tests /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/devel/docs
Black style check FAILED
───────────────────────────── isort output message ─────────────────────────────
--- /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/devel/docs/conf.py:before      2022-10-07 18:34:55.191707
+++ /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/devel/docs/conf.py:after       2022-10-07 18:35:49.855744
@@ -270,8 +270,8 @@
 # Note: this file shouldn't rely on extra dependencies.
 
 import importlib
+import os.path
 import sys
-import os.path
 
 # Borrowed from six.
 PY3 = sys.version_info[0] == 3
Skipped 4 files

───────────────────────────── isort error message ──────────────────────────────
ERROR: /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/devel/docs/conf.py Imports are incorrectly sorted and/or formatted.

Running pyflakes check: pyflakes /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/devel/buildtest /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/devel/tests /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/devel/docs
pyflakes style check FAILED
─────────────────────────── pyflakes output message ────────────────────────────
/home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/devel/docs/conf.py:278:32: undefined name 'basestring'
/home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/devel/docs/conf.py:321:9: undefined name 'html_theme_path'
/home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/devel/docs/conf.py:332:5: dictionary key 'using_theme' repeated with different values
/home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/devel/docs/conf.py:390:5: dictionary key 'using_theme' repeated with different values

──────────────────────────── pyflakes error message ────────────────────────────