Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
90 lines (64 loc) · 2.89 KB

CONTRIBUTING.md

File metadata and controls

90 lines (64 loc) · 2.89 KB
Raw

Contributing to Red-Scripts

Thank you for considering contributing to Red-Scripts! Your contributions are vital to the success and improvement of this project. Below are guidelines to help you make meaningful and efficient contributions.

How to Contribute

1. Reporting Issues

If you encounter a bug or have a feature request, please create an issue in our GitHub Issues section. Provide as much detail as possible:

  • A clear and descriptive title.
  • Steps to reproduce the issue (if applicable).
  • Expected and actual behavior.
  • Screenshots or logs (if relevant).

2. Suggesting Features

We welcome ideas for new features! To propose a feature:

  • Check the existing issues to ensure your idea hasn’t already been suggested.
  • Open a new issue with the label enhancement.
  • Provide a detailed explanation of the feature and its use case.

3. Submitting Code Contributions

To contribute code, follow these steps:

Step 1: Fork the Repository

Step 2: Clone Your Fork

  • Clone your forked repository to your local machine: 
    git clone https://github.com/w3nabil/red-scripts.git

Step 3: Create a Branch

  • Create a new branch for your contribution: 
    git checkout -b feature/your-feature-name

Step 4: Make Changes

  • Implement your changes or fixes.
  • Follow the coding style and conventions used in the project.
  • Add tests if applicable.

Step 5: Commit Changes

  • Write a clear and concise commit message: 
    git add .
git commit -m "Add a brief description of your changes"

Step 6: Push to Your Fork

  • Push your branch to your forked repository: 
    git push origin feature/your-feature-name

Step 7: Open a Pull Request

  • Go to the original repository and open a Pull Request (PR) from your forked branch.
  • Provide a detailed description of your changes and link any relevant issues.

Guidelines

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct.

Code Standards

  • Follow the existing coding style.
  • Write clear and concise comments where necessary.
  • Ensure your code is well-documented.
  • Test your changes thoroughly.

Testing

  • Ensure that all existing tests pass.
  • Add new tests for your changes if needed.

Communication

  • Be respectful and professional in all discussions.
  • Discuss major changes with the maintainers before starting development.

Recognition

We value all contributions! Contributors will be recognized in our release notes and on the Contributors page.

Thank you for helping to make Red-Scripts better! We’re excited to collaborate with you.