Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructured the Readme file #25

Merged
merged 1 commit into from
Feb 8, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 27 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,41 @@
# Linux For Pirates

This is the repository for the Linux For Pirates book. The book can be found [here](index.md).
Welcome to the Linux for Pirates project! This repository is the home of a comprehensive and user-friendly for learning about the Linux operating system and advancing as a professional in the field. With a focus on Cloud Computing and DevOps, this guide will provide you with the knowledge and skills you need to succeed in the Linux job market and secure a job as a Linux administrator. Click [here](index.md) to start reading.


<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**

- [Contributing](#contributing)
- [Style Guide](#style-guide)
- [Code of Conduct](#code-of-conduct)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Contributing
We welcome contributions from individuals of all backgrounds and experience levels. Contributions can include writing new content, editing existing content, and providing technical reviews.

To contribute to the Linux for Pirates guide, please follow these steps:

1. Open an issue: Before you start working on a contribution, we recommend opening an issue to discuss with the team. This will allow us to provide feedback and guidance and ensure that your contribution aligns with the project's goals and vision. No pull requests will be accepted without an issue, except in specific cases that will be approved on an ad-hoc basis.
2. Fork the repository: Create a copy of the repository on your own GitHub account by clicking the "Fork" button.
3. Clone the repository: Download the repository to your computer using `git clone https://github.com/YOUR-USERNAME/linux-for-pirates.git` (replace "YOUR-USERNAME" with your actual GitHub username).
4. Create a new branch: Create a separate branch for your changes using `git branch NEW-BRANCH-NAME`.
5. Make changes: Make your changes to the repository on your local computer.
6. Commit changes: Save your changes to your branch using `git commit -m "COMMIT MESSAGE"`.
7. Push changes: Upload your changes to your forked repository on GitHub using `git push origin NEW-BRANCH-NAME`.
8. Submit a pull request: Go to the main repository on GitHub and click the "Compare & pull request" button to submit your changes for review.
Git driving you nuts? Try this [approach](https://github.com/firstcontributions/first-contributions/blob/main/gui-tool-tutorials/github-windows-vs-code-tutorial.md)

## Style Guide

Please follow the [style guide](https://chat.openai.com/chat#style-guide) to maintain consistency and clarity in all content for the Linux for Pirates project. It covers language, grammar and punctuation, tone and voice, formatting, and images and media.
## Code of Conduct

We have a [Code of Conduct](https://chat.openai.com/chat#code-of-conduct) in place to ensure a positive and inclusive contribution experience for everyone. Please make sure to review and follow the code of conduct.

[Code of Conduct](https://github.com/loftwah/linux-for-pirates/blob/main/CODE_OF_CONDUCT.md) | [Contributing](https://github.com/loftwah/linux-for-pirates/blob/main/CONTRIBUTING.md) | [Style Guide](https://github.com/loftwah/linux-for-pirates/blob/main/STYLE_GUIDE.md)
We look forward to your contributions to the Linux for Pirates project!

I'll update this properly soon.
## Acknowledgements
Thank you [EddieHub](https://github.com/EddieHubCommunity) for being one of our biggest supporters in our sea voyage!