actions/labeler
1
0
Fork 0
mirror of https://github.com/actions/labeler.git synced 2025-12-11 12:07:32 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
9794b1493b6f1fa7b006c5f8635a19c76c98be95
labeler/CONTRIBUTING.md
Eric Cornelissen e26bf79ffc 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. eed9cfe64d/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.
2020-09-15 09:57:36 -04:00

1.5 KiB
Raw Blame History

Contributing Guidelines

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Contributions to this project are released to the public under the project's open-source license.

Submitting a Pull Request

  1. Fork and clone the repository
  2. Configure and install the dependencies: npm install
  3. Create a new branch: git checkout -b my-branch-name
  4. Make your change and build the action using npm run build
  5. Push to your fork and submit a pull request
  6. Pat your self on the back and wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Follow the coding style used in this project. You can do this by running npm run format.
  • 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.
  • Write good commit messages.

Resources