Contribution Guidelines
We welcome contributions to enhance the functionality and documentation of DevScripts. Please follow these steps to contribute:
-
Fork the repository on GitHub
-
Clone your forked repository:
git clone https://github.com/your-username/devscripts.git
-
Create a new branch for your feature or bugfix:
git checkout -b feature-or-bugfix-name
-
Make your changes and commit them with clear and descriptive messages.
-
Push your changes to your forked repository:
git push origin feature-or-bugfix-name
-
Submit a Pull Request to the main branch of the original repository.
-
Review process: Your pull request will be reviewed, and once approved, it will be merged into the main branch.
Contributing Content
DevScripts aims to provide high-quality, well-structured content that is easy to read and follow. If you're interested in contributing content, please adhere to the following format:
Content Format
-
Metadata: Include metadata at the top of your content file in the following format:
--- title: "Title of the Article" date: YYYY-MM-DD author: "Your Name" category: "Category Name" tags: ["tag1", "tag2", "tag3"] --- contents such as introduction, conclusion, references, etc.
-
Table of Contents: Include a table of contents for longer articles to help readers navigate the content easily.
-
Introduction: Start with an introduction that provides an overview of the topic and what the reader will learn.
-
Detailed Sections: Break down the content into sections with clear headings. Use code examples where applicable, and explain them thoroughly.
-
Conclusion: Summarize the key points and, if applicable, suggest further reading or next steps.
-
References: If you used external sources, cite them at the end of the article.
Submitting Content
-
Follow the Content Format: Ensure your content follows the structure outlined above.
-
Create a New Branch:
git checkout -b add-new-content
-
Add Your Content: Place your markdown file in the appropriate directory within the content folder.
-
Commit Your Changes:
git commit -m "Add article on [topic]"
-
Push Your Branch and submit a pull request to the main repository.