Skip to content

Latest commit

 

History

History
72 lines (49 loc) · 2.52 KB

CONTRIBUTING.md

File metadata and controls

72 lines (49 loc) · 2.52 KB

Contributing to bd-geo-info

First off, thank you for considering contributing to bd-geo-info! It's people like you that make bd-geo-info such a great tool.

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to mdtanvirahamedshanto.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the existing issues as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:

  • Use a clear and descriptive title
  • Describe the exact steps which reproduce the problem
  • Provide specific examples to demonstrate the steps
  • Describe the behavior you observed after following the steps
  • Explain which behavior you expected to see instead and why
  • Include screenshots if possible

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, please include:

  • A clear and descriptive title
  • A detailed description of the proposed enhancement
  • Examples of how the enhancement would be used
  • Why this enhancement would be useful to most users

Pull Requests

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Development Process

  1. Update your fork to the latest upstream version
  2. Install dependencies using npm install
  3. Make your changes
  4. Run tests using npm test
  5. Build the project using npm run build
  6. Ensure your code follows the existing style

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

JavaScript/TypeScript Styleguide

  • Use 2 spaces for indentation
  • Use semicolons
  • Use meaningful variable names
  • Document complex code sections
  • Write tests for new features

Questions?

Feel free to contact the project maintainer:

Thank you for your contributions!