Skip to content

Latest commit

 

History

History
108 lines (57 loc) · 3.24 KB

CONTRIBUTING.md

File metadata and controls

108 lines (57 loc) · 3.24 KB

Contributing to Argoflows

Thank you for considering contributing to Argoflows! We value and appreciate contributions of all kinds, including bug fixes, feature enhancements, documentation improvements, and more. This guide outlines the process to ensure your contributions are effective and impactful.

Table of Contents

Getting Started

To begin contributing:

  1. Fork the repository: Click the "Fork" button at the top of this repository.

  2. Clone your fork: Use below command to clone the repository.

git clone https://github.com/your-username/argoflows.git.

  1. Create a branch: Use a descriptive branch name, such as feature/add-new-feature or bugfix/fix-issue.

  2. Make changes: Implement your changes in the new branch.

  3. Test your changes: Verify that your changes work as intended.

  4. Submit a pull request: Open a pull request (PR) to the main repository for review.

How to Contribute

Reporting Issues

If you encounter a bug or have a suggestion, check the issue tracker to see if it has already been reported. If not, open a new issue and provide:

  • A clear and descriptive title.

  • Steps to reproduce the issue (if applicable).

  • Expected and actual results.

  • Relevant screenshots, logs, or additional context.

Suggesting Features

We encourage feature suggestions! Open an issue labeled enhancement and include:

  • A detailed description of the feature.

  • The problem it solves or the use case it addresses.

  • Relevant examples, references, or mockups (if applicable).

Contributing Code

To contribute code:

  1. Choose an issue labeled good first issue or help wanted from the issue tracker.

  2. Comment on the issue to indicate that you are working on it.

  3. Follow the Setup Instructions to run the project locally.

  4. Make your changes and thoroughly test them.

  5. Submit a pull request with a detailed description of your changes and their purpose.

Style Guidelines

Adhere to the following coding standards to maintain consistency:

  • Use Prettier for code formatting.

  • Follow the existing code style and structure.

  • Write clear, concise, and descriptive commit messages (e.g., "Fix: Resolve issue with login timeout").

  • Add comments for complex or non-obvious code to improve readability.

Pull Request Process

  1. Ensure your code is thoroughly tested and follows the project’s style guidelines.

  2. Write a clear and descriptive PR title and description, referencing related issues (e.g., "Closes #14").

  3. Ensure your branch is up-to-date with the main branch.

  4. Submit your PR and address any feedback from reviewers promptly.

  5. Once approved, your PR will be merged into the main branch.

Community and Support

If you have questions or need assistance, you can:

  • Start a discussion in the GitHub Discussions.

Your contributions make Argoflows better for everyone. Thank you for your support and involvement!