Skip to content

Latest commit

 

History

History
52 lines (32 loc) · 3.81 KB

CONTRIBUTION.md

File metadata and controls

52 lines (32 loc) · 3.81 KB

Contributing to this project

Contributions to this project are welcome from all!

This project is managed via Git, with the canonical upstream repository hosted on GitHub.

This repository follows a pull request model for development. If you wish to contribute, you will need to create a GitHub account, fork this project, push a branch with your changes to your project, and then submit a pull request.

See GitHub's official documentation for more details.

Getting Started

In order to contribute to this project, it is recommended that you use the following LabVIEW version:

  • Develop in LabVIEW 2015 32 bits

Contribution Workflow:

For a more complete workflow, view this set-up guide and this workflow guide.

  1. Fork this repository into your account.
  2. Create a branch for your change.
  3. Make changes, periodically pulling and merging any updates from the central repository.
  4. Push your changes up to your branch in your copy of the repository.
  5. Send a pull request to the owner of this primary repository. Follow the contribution guidelines.

Contribution Guidelines:

  • Limit the scope of your change as much as possible. Smaller changes are easier to process. Any major changes should be discussed beforehand with the managers of the repository to ensure that it fits within the goals and vision of the project.
  • Explain the reason for your change with as much detail as possible. If it is a bugfix, link it to an issue in the issues tracker. If it is an enhancement, consider making an issue in the issue tracker to discuss the enhancement before making it. This ensures that the enhancement will provide value to other users.
  • Run through the style guidelines and any available VI analyzer tests to ensure compliance with the general style of the project. Don't go crazy trying to make the code perfect. Do make sure there are no glaring issues.
  • Before committing a change, be sure to rebase or merge your code off of the most up-to-date source in the master. This reduces the risk of merge conflicts and makes it that much easier to merge your pull request and that much more likely that the change will be accepted.
  • Ensure that all builds are successful with your change in place, after rebasing.
  • Ensure that all tests pass with your change in place, after rebasing.

Contributing

After you have verified that you can successfully run the host VI, you may fork the repository and begin contributing to to the project. Make your change. On GitHub, send a new pull request to the main repository's master branch. GitHub pull requests are the expected method of code collaboration on this project.

Developer Certificate of Origin (DCO)

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

(taken from developercertificate.org)