actions
/
upload-artifact
mirror of https://github.com/actions/upload-artifact.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
upload-artifact/CONTRIBUTING.md

3.7 KiB
Raw Blame History

Contributing

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.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Found a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or a reproducable test case demonstrating the expected behavior that is not occurring.
  • If possible, use the relevant bug report templates to create the issue.

What should I know before submitting a pull request or issue

The code related to upload-artifact is split between this repository and actions/toolkit where the @actions/artifact npm package is housed. The npm package contains the core functionality to interact with artifacts. Any extra functionality on top of interacting with the APIs such as search is inside this repository. Artifact related issues will be tracked in this repository so please do not open duplicate issues in actions/toolkit.

Submitting a pull request

  1. Fork and clone the repository
  2. Configure and install the dependencies: npm install
  3. Make sure the tests pass on your machine: npm run test
  4. Create a new branch: git checkout -b my-branch-name
  5. Make your change, add tests, and make sure the tests still pass
  6. Make sure your code is correctly formatted: npm run format
  7. Make sure your code passes linting: npm run lint
  8. Update dist/index.js using npm run release. This creates a single javascript file that is used as an entry-point for the action
  9. Push to your fork and submit a pull request
  10. 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:

  • Write tests.
  • 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 a good commit message.

Licensed

This repository uses a tool called Licensed to verify third party dependencies. You may need to locally install licensed and run licensed cache to update the dependency cache if you install or update a production dependency. If licensed cache is unable to determine the dependency, you may need to modify the cache file yourself to put the correct license. You should still verify the dependency, licensed is a tool to help, but is not a substitute for human review of dependencies.

Resources

Thanks! ❤️ ❤️ ❤️

GitHub Actions Team :octocat: