2.2 KiB
Contributing Guidelines
Contributions are always welcome; however, please read this document in its entirety before submitting a Pull Request or Reporting a bug.
Table of Contents
- Reporting a bug
- Creating an issue
- Feature requests
- Opening a pull request
- Code of Conduct
- License
- Contributor license agreement
Reporting a Bug
Think you've found a bug? Let us know!
Security disclosure
Security is a top priority for us. If you have encountered a security issue please responsibly disclose it by following our security disclosure document.
Creating an Issue
Your issue must follow these guidelines for it to be considered:
Before submitting
- Check you’re on the latest version, we may have already fixed your bug!
- Search our issue tracker for your problem, someone may have already reported it
Opening a Pull Request
To contribute, fork
promptui, commit your changes, and open a pull
request.
Your request will be reviewed as soon as possible. You may be asked to make changes to your submission during the review process.
Before submitting
- Test your change thoroughly
- you can run
make bootstrap && maketo ensure that the continuous integration build will succeed
Code of Conduct
All community members are expected to adhere to our code of conduct.
License
Manifold's promptui is released under the BSD 3-Clause License.
Contributor license agreement
For legal purposes all contributors must sign a contributor license agreement, either for an individual or corporation, before a pull request can be accepted.
You will be prompted to sign the agreement by CLA Assistant (bot) when you open a Pull Request for the first time.