This is code is still alpha. The Text-based User Interface is undergoing a resign of the layout before beta. Signed-off-by: Mark D Horn <mark.d.horn@intel.com>
3.5 KiB
Contributing to Clear Linux OS Installer Project
Third-party patches and contributions are welcome. We do require you read and agree to the Contribution License Agreement below.
Contribution License Agreement
The Clear Linux OS Installer is developed and distributed under a GNU General Public License v3.0 license as noted in COPYING.
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.
Contribution Prerequisites
- Create a GitHub account if you do not already have one.
- Search the existing GitHub Issues
to see if your contribution is already documented.
- Submit a new GitHub Issue if one does not exist.
- Complete the provided template with your system configuration.
- For Bug fixes, include directions on how to reproduce the problem.
- For new functionality or features, please describe in detail the requirements.
- Submit a new GitHub Issue if one does not exist.
- Create a Fork of the repository on GitHub for your contribution.
Submitting Changes
- Create a Topic branch for your work.
- Base the topic branch on the Clear Linux OS Installer master branch
master.
- Base the topic branch on the Clear Linux OS Installer master branch
- Ensure changes follow the Go Language gofmt coding Style Guide
- Each commit needs to be functional/compile by itself.
- Follow Git Commit Guidelines
regarding commit formatting.
- Check for unnecessary whitespace with
git diff --checkbefore committing.
- Check for unnecessary whitespace with
- Rebase commits to squash where appropriate.
- Verify the Test cases are passing;
make check.- Changes with new functionality should include new test cases.
- Submit a Pull Request to the repository.
- Ensure that it is flagged as "Able to merge", if not you may need to rebase your Fork.
- List the Issues fixed by the Pull Request.
Monitor Your Pull Request
- The maintainers attempt to review all Pull Requests in a timely manner; worse case is once per week.
- If maintainers request changes or additional information for your Pull Request, the expectation is the submitter replies within two weeks.
- Pull Requests may be closed without being merged if there is no submitter response after 3+ weeks.