Skip to content

Latest commit

 

History

History
117 lines (94 loc) · 4.28 KB

CONTRIBUTING.md

File metadata and controls

117 lines (94 loc) · 4.28 KB

Contributing

Welcome! 🎉 We appreciate your interest in contributing. Below, you’ll find guidelines and best practices to help streamline the contribution process and maintain the project's quality.

Table of Contents

How to Contribute

  • Identify what to improve: Check the issues section for tasks, or suggest your own ideas.
  • Create an issue: If you want to contribute something new, please create an issue first for discussion.
  • Follow best practices: Maintain code quality, adhere to coding standards, and document your changes properly.

Contributions You Can Make

Configuration Files

Enhance or create configurations for different packages, ensuring a seamless and better experience:

  • Kitty: Custom color schemes, shortcuts, or advanced configurations.
  • Neovim: Lua-based configs, plugin setups, or themes.
  • Other Tools: Configurations for utilities like zsh, tmux, or alacritty.
  • DWM Config Files: Tweak config.h, key bindings, layouts, and settings for better usability.

Patches

Develop, update, or test DWM patches for features like:

  • Gap management
  • Rounded corners
  • Bar improvements
  • Any innovative idea you have!

Documentation

Help keep our documentation top-notch by:

  • Updating the README.md.
  • Writing detailed guides for installation and usage.
  • Adding comments to explain tricky parts of the code.

Visual Enhancements

Ensure contributors have an aesthetically pleasing environment by:

  • Suggesting themes or wallpapers.
  • Creating visual previews of the configurations and patches.

Code Style and Guidelines

  • C Code:

    • Indentation: 4 spaces, no tabs.
    • Follow naming conventions for functions and variables.
    • Document all major functions with comments.

  • Markdown Files:

    • Use proper headings and structure.
    • Maintain consistent formatting.

  • General:

    • Write clean, maintainable code.
    • Ensure commits are atomic and well-documented.
    • Test thoroughly before submission.

Getting Started

Fork and Clone the Repository

  • Fork this repository to your GitHub account.
  • Clone the forked repository to your local system: 
    git clone https://github.com/your-username/dwm

Create a Feature Branch

Create a new branch for your feature or fix:

git checkout -b feature-name

Submit a Pull Request

  • Push your changes to the forked repository: 
    git push origin feature-name
  • Open a pull request from your feature branch to the main branch of this repository.
  • Add a detailed description of your changes and link the issue (if applicable).

Using GitHub Desktop

If you prefer a graphical interface, you can use GitHub Desktop to contribute:

  • Clone the repository:

    • Open GitHub Desktop and sign in with your GitHub account.
    • Click File > Clone repository, then select the forked repository.

  • Create a new branch:

    • Click Branch > New branch, name your branch, and click Create branch.

  • Make changes:

    • Use your preferred editor to make changes to the files.
    • Save your work and return to GitHub Desktop, where you can see the changed files.

  • Commit and push changes:

    • Write a commit message summarizing your changes.
    • Click Commit to <branch-name> and then Push origin.

  • Open a pull request:

    • In GitHub Desktop, click Branch > View on GitHub to open the repository in your browser.
    • Follow the steps to create a pull request.

Communication

If you have any questions, feel free to:

  • Open an issue for general queries or suggestions.
  • Discuss with maintainers in the comments section of an issue or pull request.

Thank you for helping make this project awesome! 💖