Contributing Code

Introduction

The NetFPGA project is only as good as its community is, and contributing code to the NetFPGA repository is the best way to help the community!

You can contribute to the repository in many ways, including (but not limited to):

• Whole projects
• IP cores (modules)
• Applications
• Drivers
• Scripts
• Tests
• Bug fixes
• Code enhancements
• Documentation (wiki, contrib-docs)

You do not need to be a professional FPGA engineer, nor does your code need to be perfect - every bit and piece can help.

What can be contributed?

Only code that you wrote can be contributed.

Do not include any code that you took from other sources. The way to handle such code is to provide a link to its source.

Do not include any outputs of tools. Instead, provide scripts to generate these outputs.

At this stage, bitfiles can not be part of the repository. We are happy to host the bitfiles on the NetFPGA servers and provide a link to them from within the repository. You can update these bitfiles if need be.

How to contribute?

Start by sending an email to the NetFPGA SUME mailing list, providing information on what you'd like to contribute. The NetFPGA can then consult you on the contents of the contribution, location of the code within the repository etc.

You will next need to create a pull request from a fork of the NetFPGA-SUME-live repository (with your code in it) to the master repository. If the code complies with the instructions above it will be merged.

Please make sure to update the wiki's contributed code page with information regarding your contribution.

That's it. The NetFPGA community thanks you!

Contributing for the first time

If this is the first time that you are contributing to NetFPGA you will need to sign a contributor agreement (For more details refer to the license wiki page).

A contributor agreement needs to be signed only once.