Skip to content

Latest commit

 

History

History
53 lines (29 loc) · 2.61 KB

CONTRIBUTING.md

File metadata and controls

53 lines (29 loc) · 2.61 KB
Raw

Contribution Guidelines

Hey there, fellow scripter! Thank you for your interest in contributing to the Bash Blaze challenge! Here are some guidelines to follow while making your contribution:

Types of Contributions

You can contribute in the following ways:

  1. Bug Fixes: If you find any issues or bugs in the challenge description, instructions, or solutions, please feel free to fix them and submit a pull request.

  2. Enhancements: If you have any ideas to improve the challenge scenario, objectives, or instructions, you can propose enhancements through pull requests.

  3. Translations: If you want to translate the challenge content into other languages, you are welcome to do so. Please create a new folder for the translated version and include the README.md, challenge.md, and any necessary script files.

  4. New Challenges: If you have ideas for new and exciting challenges related to Bash scripting or any other programming concepts, you can propose them as well.

How to Contribute

  1. Fork the repository to your GitHub account.

  2. Create a new branch for your contribution: git checkout -b your-branch-name.

  3. Make your changes or additions.

  4. Commit your changes: git commit -m "Description of changes".

  5. Push your changes to your forked repository: git push origin your-branch-name.

  6. Create a pull request to the original repository with a clear description of your changes.

Challenge Structure

The challenges are structured in a specific format. When proposing new challenges or making changes to existing ones, please follow the structure outlined in the existing challenges:

  • Challenge Title: A concise title describing the challenge.
  • Challenge Scenario: A brief description of the problem scenario.
  • Challenge Objectives: A list of specific goals participants should achieve in the challenge.
  • Instructions: Step-by-step instructions to complete the challenge.
  • Solution Details: A detailed solution explanation, including code snippets or scripts.

Code Quality

If your contribution involves code, please ensure that it follows best practices, is well-documented, and adheres to the coding conventions used in the repository.

Review Process

All contributions will be reviewed by the repository maintainers. Feedback or suggestions for improvements may be provided, and changes might be requested before merging the pull request.

Licensing

By contributing to this repository, you agree to license your contributions under the same license as the repository (if applicable).

Thank you for your valuable contributions to the Bash Blaze challenge! Happy scripting! 🚀