Files
warewulf/docs/Contributing.md
2020-12-22 22:26:29 -08:00

1.3 KiB

Contributing

Warewulf is an open source project and we invite your collaboration and help.

Contributor's Agreement

You are under no obligation whatsoever to provide any bug fixes, patches, or upgrades to the features, functionality or performance of the source code ("Enhancements") to anyone; however, if you choose to make your Enhancements available either publicly, or directly to the project, without imposing a separate written license agreement for such Enhancements, then you hereby grant the following license: a non-exclusive, royalty-free perpetual license to install, use, modify, prepare derivative works, incorporate into other computer software, distribute, and sublicense such enhancements or derivative works thereof, in binary and source code form.

To Contribute

Here is the very high level guide to contributing:

  • For the project to a location of your choosing
  • Clone your fork locally: git clone http://github.com/$NAME/warewulf.git
  • Inside your fork, create a local branch: cd warewulf; git checkout -b localchanges
  • Make the necessary changes and commit them: git commit -a
  • Push your changes: git push origin localchanges
  • Create a PR using GitHub: https://github.com/$NAME/warewulf/pull/new/localchanges

note: set your environment variable NAME=github_username before running the above commands.