Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
79 lines (51 loc) · 3.38 KB

CONTRIBUTING.md

File metadata and controls

79 lines (51 loc) · 3.38 KB

Contributing

Contributions to Mini-ISP are very welcome!

Please follow the steps below and be sure that your contribution complies with our guidelines.

  1. Share your proposal via Github issues.

  2. Submit your pull request:

    1. Fork this repository to your own GitHub account using the fork button above.

    2. Clone the fork to your local computer using git clone. Checkout the branch you want to work on. If you are using Windows, you best clone within WSL and use Visual Sudio Code to connect to the project's dev container within WSL.

    3. If you are working outside of the project's dev container, please install at least prek to ensure your code is formatted to our style guidelines. If you prefer, you can also use pre-commit.

    4. Modify the source code as needed.

    5. Use git add, git commit, git push to add changes to your fork.

    6. If you are introducing new functionality, add at least one unit test or test bench and make sure it passes before you submit the pull request.

    7. Submit a pull request by clicking the pull request button on your GitHub repo.

  3. Sign Your Work

Please use the Signed-off-by line at the end of your patch which indicates that you accept the Developer Certificate of Origin (DCO) reproduced below:

  Developer Certificate of Origin
  Version 1.1

  Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
  1 Letterman Drive
  Suite D4700
  San Francisco, CA, 94129

  Everyone is permitted to copy and distribute verbatim copies of this
  license document, but changing it is not allowed.


  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.

You can enable Signed-off-by automatically by adding the -s flag to the git commit command.

Here is an example Signed-off-by line which indicates that the contributor accepts DCO:

  This is my commit message

  Signed-off-by: Jane Doe <jane.doe@example.com>
  1. We will review your contribution and, if any additional fixes or modifications are necessary, may provide feedback to guide you. When accepted, your pull request will be merged to the repository. If you have more questions please contact us.