Skip to content

Latest commit

 

History

History
68 lines (41 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

68 lines (41 loc) · 2.19 KB
Raw

Contributing

Contributions are welcomed and greatly appreciated! Every little bit helps and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/PaloAltoNetworks/HomeSkillet/issues.

If you are reporting a bug, please include:

  • The PAN-OS or Panorama version you are running.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the issue.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" is open to whoever wants to implement it.

Write Documentation

The HomeSkillet project is managed by engineers. As such, it could always use better documentation. Any edits that helps make the documentation clearer and more effective is greatly appreciated.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/PaloAltoNetworks/HomeSkillet/issues.

If you are proposing a change:

  • Explain in detail why it is needed.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project and that contributions are welcome :)

Get Started!

Ready to contribute? Here's how to set up HomeSkillet for local development.

  1. Fork the HomeSkillet repo on GitHub.

  2. Clone your fork locally.

    $ git clone [email protected]:your_name_here/HomeSkillet.git

    $ cd HomeSkillet

  3. Create a branch for local development.

    $ git checkout -b name-of-your-branch

  4. Edit the XML configuration snippets locally. An XML editor is recommended to ensure proper XML structure.

  5. Import the XML configuration snippet into a non-production NGFW, load it into the candidate configuration, and ensure that the candidate configuration commits without errors.

  6. Commit your changes and push your branch to GitHub::

    $ git add .

    $ git commit -m "Your detailed description of your changes."

    $ git push origin name-of-your-branch

  7. Submit a pull request through the GitHub website.