Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (21 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

30 lines (21 loc) · 1.44 KB

Contributing to GitHub Contribution Graph Enhancer

Thank you for considering contributing to this project! We welcome contributions from the community.

How to Contribute

  1. Fork the Repository: Click the 'Fork' button at the top right of the repository page.
  2. Clone Your Fork: git clone https://github.com/YOUR_USERNAME/github-bot.git
  3. Create a Branch: git checkout -b feature/your-feature-name or bugfix/issue-description
  4. Make Your Changes: Implement your feature or fix the bug.
  5. Test Your Changes: Ensure your changes work as expected and do not introduce new issues.
  6. Commit Your Changes: Write clear and concise commit messages. git commit -m "feat: Add feature X" or fix: Resolve issue Y
  7. Push to Your Fork: git push origin feature/your-feature-name
  8. Open a Pull Request: Go to the original repository and open a pull request from your fork's branch to the main branch of the original repository.

Reporting Issues

If you find a bug or have a suggestion, please open an issue on the GitHub repository. Provide as much detail as possible, including:

  • Steps to reproduce the issue.
  • Expected behavior.
  • Actual behavior.
  • Screenshots (if applicable).
  • Your environment details (OS, Node.js version).

Code Style

Please try to follow the existing code style. If you add new dependencies, update the package.json file accordingly.

We appreciate your contributions!