Skip to content

Latest commit

 

History

History
112 lines (73 loc) · 3.82 KB

CONTRIBUTING.md

File metadata and controls

112 lines (73 loc) · 3.82 KB
Raw

Contributing

Thank you for your interest in contributing to FawltyDeps! We welcome contributions from the community to help improve our project. Please take a moment to review this guide before you get started.

Table of Contents

Code of Conduct

Getting Started

Making Changes

Submitting Pull Requests

Review Process

Code of Conduct

We expect all contributors to adhere to our Code of Conduct. Please read it carefully before contributing.

Getting Started

Fork the Repository

If you haven't already, fork the FawltyDeps GitHub Action repository on GitHub. This will create a copy of the project in your GitHub account.

Clone the Repository

Clone your fork of the repository to your local machine:

git clone [email protected]:<your_username>/FawltyDeps-action-action-action-action-action-action-action-action.git

Set Up Your Development Environment

Docker

This uses Docker to package the container needed for the GitHub action.

Making Changes

Branch Naming

Create a new branch with a descriptive name for your feature or fix.

Commit Messages

Write clear and concise commit messages that describe your changes.

Testing

Running Tests Locally

You can use nektos/act to run this action locally for testing.

Submitting Pull Requests

When you're ready to submit your changes:

  1. Push your changes to your forked repository: 
    git push origin feature/your-feature-name
  2. Visit the FawltyDeps GitHub Actions repository on GitHub.
  3. Click the "New Pull Request" button.
  4. Select the appropriate branch and describe your changes in the pull request. Be sure to reference any related issues.

Review Process

Contributions to FawltyDeps go through a review process to ensure code quality and alignment with project goals. Here's how the review process works:

  1. Submission: When you submit a pull request (PR), our automated CI/CD pipeline will run tests to check for issues and ensure that the code meets our coding standards.

  2. Code Review: A maintainer or fellow contributor will review your PR. They will provide feedback, suggest improvements, and ensure that the changes align with the project's goals and coding guidelines.

  3. Discussion: If changes or clarifications are needed, you may need to engage in discussions with reviewers to address feedback and make necessary adjustments.

  4. Approval: Once the PR meets all requirements and receives approval from one or more maintainers or contributors, it will be labeled as "approved."

  5. Addressing Change Requests: If a reviewer requests changes, please make the necessary adjustments and commit the changes with a clear reference to the reviewer's comment. Use the commit hash to indicate the changes you made. The reviewer is responsible for resolving their comment once they are satisfied with the changes.

  6. Merging: A maintainer will merge the PR into the main branch. Please note that only maintainers have merge permissions.

  7. Thank You! Your contribution has now become a part of FawltyDeps. Thank you for your contribution to the project!

We appreciate your contributions and value the effort you put into improving our project. If you have any questions or need assistance during the review process, feel free to ask in the PR discussion!