You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The Nushell website has links at the bottom of the page to "Edit this page on GitHub". Clicking the link takes the user through the process of updating that page using the GitHub web interface to create a pull request. That user flow bypasses the CONTRIBUTING.MD and it's not until after the PR is submitted the user is notified about not updating autogenerated docs.
Some suggestions to improve this for first time contributors.
Remove the "Edit this page on GitHub" links on pages that should not be edited.
Change or create the GitHub issue template specifying that certain pages, trees roots or paths should not be modified.
Add a note about contributing to the README.md. As it is, the user is expected to know about the CONTRIBUTING.md document.
The text was updated successfully, but these errors were encountered:
The nushell repo has a good example for the template:
# Description
<!--
Thank you for improving Nushell. Please, check our [contributing guide](../CONTRIBUTING.md) and talk to the core team before making major changes.
Description of your pull request goes here. **Provide examples and/or screenshots** if your changes affect the user experience.
-->
The Nushell website has links at the bottom of the page to "Edit this page on GitHub". Clicking the link takes the user through the process of updating that page using the GitHub web interface to create a pull request. That user flow bypasses the CONTRIBUTING.MD and it's not until after the PR is submitted the user is notified about not updating autogenerated docs.
Some suggestions to improve this for first time contributors.
The text was updated successfully, but these errors were encountered: