Skip to content

Latest commit

 

History

History
54 lines (32 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

54 lines (32 loc) · 2.51 KB
Raw

Contributing Guide

Thank you for your interest in contributing to our GitHub Actions repository! We appreciate your efforts to help improve and expand our collection of GitHub Actions. Below are some guidelines to help you get started.

Developer Certificate of Origin (DCO)

Before contributing, you must agree to the DCO. This is a lightweight way to certify that you wrote or have the right to submit your contribution and that you agree to license it under the project's license. To signify your agreement, simply add a Signed-off-by line to your commit message, using your real name and email address.

Here is an example of how you can add a Signed-off-by line to your commit message:

Signed-off-by: John Doe <[email protected]>

By signing off your contribution, you acknowledge and agree to the following:

  • You have the right to submit your contributions.
  • Your contributions are licensed under the project's license.

How to Contribute

1. Reporting Issues

If you encounter any bugs, issues, or have suggestions for improvements, please open an issue in the repository. Provide as much detail as possible to help us understand and reproduce the issue.

2. Submitting Pull Requests

We welcome pull requests for new actions or improvements to existing ones. To ensure a smooth process, please:

  1. Make Changes: Implement your changes in the appropriate subdirectory. Ensure each action has a clear and comprehensive README file.
  2. Sign Your Work: Before committing your changes, ensure each commit message includes a Signed-off-by line.
  3. Commit Changes: Commit your changes with a meaningful commit message.
  4. Open a Pull Request: Open a pull request from your forked repository. Provide a clear description of your changes and reference any related issues.

3. Code Style and Quality

  • Ensure your code follows the repository's coding standards.
  • Write clear and concise commit messages.
  • Update documentation as necessary.

4. Reviewing and Feedback

We will review your pull request as soon as possible. Please be patient and responsive to any feedback or requested changes.

5. Community Guidelines

Be respectful and considerate in all interactions. We value contributions from everyone and aim to create a welcoming and inclusive environment.

Resources

Thank you for your contributions! We look forward to working with you.