#How To Contribute
We use git as our version control system. To streamline the process of giving proper credit to the contributors when committing patches, we encourage contributors to submit patches generated using git format-patch. This has many benefits:
Long story short, it makes both the contributors' and committers' lives easier, so please generate your patches using git format-patch.
Here are some instructions on how to generate patches:
YETUS-1. Update shellcheck plug-in to support bats files
git format-patch HEAD^..HEAD --stdout > YETUS-1.00.patch
The naming of the patch should be in (JIRA).(patch number).patch or, if it needs to apply to a specific branch, (JIRA).(branch name).(patch number).patch format. For example, YETUS-9.00.patch, YETUS-500.02.patch, or YETUS-23.cmake.11.patch. This way, if you need to upload another version of the patch, you should keep the file name the same and JIRA will sort them according to date/time if multiple files have the same name. This feature is also useful to traceback the history of a patch and roll-back to an earlier version if needed.
We use middleman to generate the website content from markdown and other dynamic templates. The following steps assume you have a working ruby 2.x environment setup:
gem install bundler bundle install
Make any changes in the source directory:
cd asf-site-src/source vi contribute.html.md
To generate the static wesbite for Apache Yetus run the following commands at the root asf-site-src directory:
bundle exec middleman build
Live development of the site enables automatic reload when changes are saved. To enable run the following command and then open a browser and navigate to http://localhost:4567
bundle exec middleman
Commit the publish directory to the asf-site branch.