Skip to content

Commit e26bf79

Browse files
Draft contributors.md update (#97)
* Draft contributors.md update This is a proposed updated to the contributors.md document inspired by the contributing guidelines of the actions/cache project [1]. There are some differences, most notable the inclusion of "Development Details" which explains and motivates the development tools (to an extend). -- 1. https://github.com/actions/cache/blob/eed9cfe64d00dd64cbb36bec915d41dd6fab9f6c/CONTRIBUTING.md * Split Contributing Guidelines and Development Handbook Split the "Contributing Guidelines" currently found in docs/contributors.md into a CONTRIBUTING.md file, containing the Contributing Guidelines, and a docs/development.md file, containing details on how the development/testing of this project works.
1 parent bab1304 commit e26bf79

File tree

3 files changed

+31
-22
lines changed

3 files changed

+31
-22
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Contributing Guidelines
2+
3+
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
4+
5+
Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open-source license](../LICENSE).
6+
7+
## Submitting a Pull Request
8+
9+
1. [Fork](https://github.com/actions/labeler/fork) and clone the repository
10+
1. Configure and install the dependencies: `npm install`
11+
1. Create a new branch: `git checkout -b my-branch-name`
12+
1. Make your change and build the action using `npm run build`
13+
1. Push to your fork and [submit a pull request](https://github.com/actions/labeler/compare)
14+
1. Pat your self on the back and wait for your pull request to be reviewed and merged.
15+
16+
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
17+
18+
- Follow the coding style used in this project. You can do this by running `npm run format`.
19+
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
20+
- Write [good commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
21+
22+
## Resources
23+
24+
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
25+
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
26+
- [GitHub Help](https://help.github.com)

docs/contributors.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

docs/development.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Development Handbook
2+
3+
This project is written in [TypeScript](https://www.typescriptlang.org/), a typed variant of JavaScript, and we use [Prettier](https://prettier.io/) to get a consistent code style.
4+
5+
Because of how GitHub Actions are run, the source code of this project is transpiled from TypeScript into JavaScript. The transpiled code (found in `lib/`) is subsequently compiled using [NCC](https://github.com/vercel/ncc/blob/master/readme.md) (found in `dist/`) to avoid having to include the `node_modules/` directory in the repository.

0 commit comments

Comments
 (0)