Files
setup-ruby/docs/contributors.md

30 lines
1.7 KiB
Markdown
Raw Permalink Normal View History

2019-06-26 14:22:50 -04:00
# Contributors
2020-01-12 10:05:14 -05:00
### Changes
2020-01-12 10:08:22 -05:00
The process is consistent for internal and external contributions. The only difference is external contributions PRs come from a fork.
2020-01-12 10:05:14 -05:00
For trivial bug fixes, create an issue to discuss and then a PR can follow referencing the issue.
For enhancements and new features, create an enhancment issue for discuss followed by a [design proposal known as an ADR](https://github.com/actions/setup-ruby/blob/adrs/adrs/README.md). This allows everyone to get to consensus before coding and also serves as a record going forward.
2019-06-26 14:22:50 -04:00
### Checkin
- Do checkin source (src)
- Do checkin build output (lib)
- Do checkin runtime node_modules
- Do not checkin devDependency node_modules (husky can help see below)
### devDependencies
In order to handle correctly checking in node_modules without devDependencies, we run [Husky](https://github.com/typicode/husky) before each commit.
This step ensures that formatting and checkin rules are followed and that devDependencies are excluded. To make sure Husky runs correctly, please use the following workflow:
```
npm install # installs all devDependencies including Husky
git add abc.ext # Add the files you've changed. This should include files in src, lib, and node_modules (see above)
git commit -m "Informative commit message" # Commit. This will run Husky
```
During the commit step, Husky will take care of formatting all files with [Prettier](https://github.com/prettier/prettier) as well as pruning out devDependencies using `npm prune --production`.
It will also make sure these changes are appropriately included in your commit (no further work is needed)