RepoMirrors/HackBrowserData
1
0
Fork 0
mirror of https://github.com/moonD4rk/HackBrowserData synced 2025-03-04 18:37:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
e48f35cfd3
HackBrowserData/CONTRIBUTING.md
ᴍᴏᴏɴD4ʀᴋ 23037e16fd
Chore: Add CONTRIBUTING.md guidelines and standardized templates (#279) 
* chore: Improve GitHub workflows, issue template, and gitignore entries

- Add support for manual triggering of build and lint workflows.
- Improve bug report template by clarifying prompts and adding checklist and tips for better explanation of issues.
- Ignore `.md` files in `.github` and `.github/ISSUE_TEMPLATE` folders.
- Add badges for test running and coverage status in README.md.

* chore: Add standardized templates to repository

- Add pull request and feature request templates to the `.github` folder

* docs: Add CONTRIBUTING.md guidelines and update .gitignore.

- Update .gitignore to remove exclusions for browsing history files
- Add an exclusion for CONTRIBUTING.md in the Community section in .gitignore
- Create CONTRIBUTING.md with guidelines for contributors.
2024-01-13 18:08:35 +08:00

1.3 KiB
Raw Blame History

Contributing to HackBrowserData

We appreciate your interest in contributing to the HackBrowserData! This document provides some basic guidelines for contributors.

Getting Started

  • Always base your work from the dev branch, which is the development branch with the latest code.
  • Before creating a Pull Request (PR), make sure there is a corresponding issue for your contribution. If there isn't one already, please create one.
  • Include the problem description in the issue.

Pull Requests

When creating a PR, please follow these guidelines:

  • Link your PR to the corresponding issue.
  • Provide context in the PR description to help reviewers understand the changes. The more information you provide, the faster the review process will be.
  • Include an example of running the tool with the changed code, if applicable. Provide 'before' and 'after' examples if possible.
  • Include steps for functional testing or replication.
  • If you're adding a new feature, make sure to include unit tests.

Code Style

Please adhere to the existing coding style for consistency.

Questions

If you have any questions or need further guidance, please feel free to ask in the issue or PR, or reach out to the maintainers.

Thank you for your contribution!