Skip to content

Latest commit

 

History

History
56 lines (36 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

56 lines (36 loc) · 1.8 KB

Contributing

If you have an idea or feature request please open an issue, even if you don't have time to contribute!

Making Changes

Note: This guide assumes you have a working FreeBSD 13.0 or later installation.

To get started, fork this repository on GitHub and clone a working copy for development:

$ git clone git@github.com:YOUR-USERNAME/dynamic_motd.git

Once you are finished, be sure to test changes locally and verify installation by issuing:

# setenv DESTDIR `mktemp -d`
# make install

Finally, commit your changes and create a pull request against the master branch for review.

Making New Releases

Making new releases is automated by GitHub Actions. Releases should only be created from the master branch.

To make a new release, follow these steps:

  1. Verify the latest results of the CI workflow on the master branch.

  2. Create a release tag by issuing:

    $ git tag -a -m 'Release v<version>' v<version>
    
  3. Push the release tag to the remote repository and verify the results of the Release workflow:

    $ git push origin --tags
    
  4. Submit a patch downstream for the sysutils/dynamic_motd port. See the FreeBSD Porter's Handbook for more details.

License

By contributing to this repository, you agree that your contributions will be licensed under its Simplified BSD License.