diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..d1c458c04 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,33 @@ +--- +name: Pull request +about: Push a change to this project +--- + +### Motivate of the pull request +- [ ] To address an existing issue. If so, please provide a link to the issue. +- [ ] Breaking new feature. If so, please decribe details in the description part. + +### Describe the technical details +- What is currently done? (Provide issue link if applicable) +- What does this pull request change? + +### Which part of the code base require a change +**In general, modification on existing submodules are not acceptable. You should push changes to upstream.** +- [ ] VPR +- [ ] OpenFPGA libraries +- [ ] FPGA-Verilog +- [ ] FPGA-Bitstream +- [ ] FPGA-SDC +- [ ] FPGA-SPICE +- [ ] Flow scripts +- [ ] Architecture library +- [ ] Cell library + +### Checklist of the pull request +- [ ] Require code changes. +- [ ] Require new tests to be added +- [ ] Require an update on documentation + +### Impact of the pull request +- [ ] Require a change on Quality of Results (QoR) +- [ ] Break back-compatibility. If so, please list who may be influenced. diff --git a/.github/labeler.yml b/.github/labeler.yml new file mode 100644 index 000000000..f2a30f198 --- /dev/null +++ b/.github/labeler.yml @@ -0,0 +1,103 @@ +# See https://github.com/actions/labeler#common-examples for defining patterns. +# The globs use "minimatch" syntax found at https://github.com/isaacs/minimatch +# +# WARNING: Due to this file being yaml, any string starting with `*` must be +# wrapped in quotes. + +# Third-party tools +ABC: + - abc/* + - abc/**/* +ACE2: + - ace2/* + - ace2/**/* +VPR: + - vpr/* + - vpr/**/* + - libs/**/* + +# General areas +documentation: + - docs/* + - docs/**/* + - "*README*" + - "*.md" + - tutorial + - "*.rst" + - ".readthedocs.yml" +github: + - .github/* + - .github/**/* +docker: + - Dockerfile + - "*docker*" +build: + - Makefile + - "*.make" + - CMakeLists.txt + - cmake +libopenfpga: + - "libopenfpga/**" +libopenfpga-bitstream: + - "libopenfpga/libfpgabitstream/**" +libopenfpga-arch-parser: + - "libopenfpga/libarchopenfpga/**" +libopenfpga-fabric-key: + - "libopenfpga/libfabrickey/**" +libopenfpga-shell: + - "libopenfpga/libopenfpgashell/**" +libopenfpga-utils: + - "libopenfpga/libopenfpgautil/**" +openfpga-tools: + - "openfpga/**" +openfpga-verilog: + - "openfpga/*/fpga_verilog/**" +openfpga-sdc: + - "openfpga/*/fpga_sdc/**" +openfpga-bitstream: + - "openfpga/*/fpga_bitstream/**" +openfpga-spice: + - "openfpga/*/fpga_spice/**" +flow-scripts: + - "openfpga_flow/scripts/**" + - "openfpga_flow/openfpga_shell_scripts/**" + - "openfpga_flow/openfpga_simulation_settings/**" + - "openfpga_flow/misc/**" +architecture-description: + - "openfpga_flow/vpr_arch/**" + - "openfpga_flow/openfpga_arch/**" + - "openfpga_flow/fabric_keys/**" +bitstream: + - "openfpga_flow/fabric_keys/**" +cell-library: + - "openfpga_flow/openfpga_cell_library/**" + - "openfpga_flow/tech/**" +benchmarks: + - "openfpga_flow/benchmarks/**" +tests: + - "openfpga_flow/tasks/**" + +# Tag pull requests with the languages used to make it easy to see what is +# being used. +lang-hdl: + - "*.v" + - "*.sv" +lang-cpp: + - "*.c*" + - "*.h" +lang-perl: + - "*.pl" + - "*perl*" +lang-python: + - "*.py" +lang-shell: + - "*.sh" +lang-netlist: + - "*.blif" + - "*.eblif" + - "*.edif" + - "*.vqm" +lang-make: + - "*.make" + - Makefile + - CMakeLists.txt \ No newline at end of file diff --git a/.github/workflows/labeler.yml b/.github/workflows/labeler.yml new file mode 100644 index 000000000..20a5e480d --- /dev/null +++ b/.github/workflows/labeler.yml @@ -0,0 +1,12 @@ +name: "Pull Request Labeler" +on: +- pull_request_target + +jobs: + triage: + runs-on: ubuntu-latest + steps: + - uses: actions/labeler@main + with: + repo-token: "${{ secrets.GITHUB_TOKEN }}" + configuration-path: ".github/labeler.yml" diff --git a/docs/requirements.txt b/docs/requirements.txt index 46beeb9a4..2236fda06 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -6,7 +6,7 @@ #recommonmark #Handle references in bibtex format -sphinxcontrib-bibtex +sphinxcontrib-bibtex<2.0.0 #Work-around bug "AttributeError: 'Values' object has no attribute 'character_level_inline_markup'" with docutils 0.13.1 #See: