Skip to content

Contribute.md

Latest commit

 

History

History
85 lines (62 loc) · 2.73 KB

Contribute.md

File metadata and controls

85 lines (62 loc) · 2.73 KB
![Contribute](https://img.shields.io/badge/Contribute-%F0%9F%9A%A1-blue) \
# Contributing to readmeMaker

## 💡 **Welcome to the readmeMaker community!**

We are thrilled that you are considering contributing. Your efforts are truly appreciated. Whether you find a bug, improve existing code, or add new features, your contributions are recognized and celebrated.

## 🛠️ Getting Started

Follow these steps to get the project up and running on your local machine.

### 🔧 **Fork and Clone**

1. **Fork** this repository to your GitHub account.
   ![Fork](https://img.shields.io/badge/Fork-blue)
2. **Clone** your forked repository:
   ```sh
   git clone https://github.com/waloncCode/readmeMaker.git
   cd readmeMaker
  1. Set upstream remote: 
    git remote add upstream https://github.com/walonCode/readmeMaker.git

🎯 Set up the Project

  1. Ensure [Go] installed on your machine. Then, navigate to the project root and run: 
    go mod tidy
  2. Run the tests to ensure everything is set up properly: 
    go test ./...

🗂️ Branch Naming Convention

All new features and fixes should be created in a new branch. Use the following conventions:

  • For feature branches: feature/feature-name
  • For bug fixes: bugfix/bug-description
  • For enhancements or improvements: enhancement/detail-description

🐛 Submitting Issues

Before you submit an issue:

  • Make sure it isn't already reported by searching the issues.
  • Provide a clear and concise title and description.
  • Include steps to reproduce the issue, and if applicable, expected vs. actual results.

🏗️ Submitting Pull Requests

Our workflow is as follows:

  1. Fork this repository.
  2. Clone your fork and setup the project as described above.
  3. Create a new branch following the naming conventions.
  4. Make changes and commit them with meaningful messages:
    • Prefix fixes with fix: and improvements with chore:
  5. Push your branch and submit a pull request.
  6. Request a code review and make the requested changes if necessary.

Your pull request must pass all checks before being reviewed.

Code Style and Linting

  • Use go fmt to ensure consistent code formatting.
  • Run golangci-lint run to enforce code quality with various linters.
golangci-lint run

🗣 Communication Etiquette

  1. Be respectful and considerate.
  2. Provide context for your actions.
  3. Write clear, concise, and helpful messages.

Every piece of your contribution helps us improve and grow. Thank you!

Thank you for being a part of readmeMaker!