Skip to content

Latest commit

 

History

History
90 lines (58 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

90 lines (58 loc) · 2.17 KB

Contributing to PB_Website

Thank you for your interest in contributing to the PB_Website project! We welcome all contributions, whether they are bug fixes, new features, documentation improvements, or anything else that makes our project better.

How to Contribute

1. Fork the Repository

Click the Fork button on the top right of the repository page to create your own copy of the project.

2. Clone Your Fork

git clone https://github.com/YOUR-USERNAME/PB_Website.git
cd PB_Website

3. Set Upstream Remote

To keep your fork up-to-date:

git remote add upstream https://github.com/pointblank-club/PB_Website.git
git fetch upstream

4. Create a New Branch

Create a branch for your feature or fix:

git checkout -b my-feature

5. Make Your Changes

  • Make your changes in the codebase.
  • Test your changes if applicable.
  • Update documentation if necessary.

6. Commit Your Changes

Write clear, concise commit messages.

git add .
git commit -m "Describe your change"

7. Push to Your Fork

git push origin my-feature

8. Create a Pull Request

  • Go to your fork on GitHub.
  • Click Compare & pull request.
  • Add a descriptive title and detailed description.
  • Reference any related issues (e.g., “Closes #123”).
  • Submit the pull request to the main branch.

Code Style & Conventions

  • Follow the style/conventions used in the existing codebase.
  • Write clear and descriptive variable and function names.
  • If you are unsure, open a draft PR to get feedback.

Reporting Issues

If you find a bug or want to request a feature:

  • Open an issue here.
  • Search existing issues before submitting a new one.

Pull Request Review Process

  1. Your PR will be reviewed by maintainers.
  2. You may be asked for changes or clarifications.
  3. Once approved, your PR will be merged.

Code of Conduct

By participating, you agree to abide by our community’s code of conduct.

Questions?

If you have any questions, please open an issue or start a discussion.

Thank you for your contributions!