-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat[#2]: Added (Code of Conduct, Issues/PR templates, Contributing, …
…security, etc..) (#7)
- Loading branch information
1 parent
10cfc18
commit a7d05f7
Showing
10 changed files
with
458 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
# Contributing to FPS Game Game | ||
|
||
Welcome to FPS Game! We appreciate your interest in contributing to our project. Please take a moment to read through this guide to understand how you can help us make this game even better. | ||
|
||
## Table of Contents | ||
|
||
- [Getting Started](#getting-started) | ||
- [Reporting Bugs](#reporting-bugs) | ||
- [Requesting Features](#requesting-features) | ||
- [Contributing Code](#contributing-code) | ||
- [Development Setup](#development-setup) | ||
- [Code Style](#code-style) | ||
- [Submitting a Pull Request](#submitting-a-pull-request) | ||
- [Community and Communication](#community-and-communication) | ||
|
||
## Getting Started | ||
|
||
Before you start contributing to FPS Game, please make sure you have: | ||
|
||
- A GitHub account; | ||
- Familiarity with Godot Engine; | ||
- Read and understood our [Code of Conduct](CODE_OF_CONDUCT.md) and [Project Best Practices](https://github.com/Mangito/FPS/wiki/ProjectBestPractices); | ||
|
||
## Reporting Bugs | ||
|
||
If you encounter a bug or unexpected behavior in the game, please check if it has already been reported by searching the [Issues](https://github.com/Mangito/FPS/issues). If it hasn't been reported yet, feel free to open a new issue (using the Bug Report issue template) and provide as much detail as possible. | ||
|
||
## Requesting Features | ||
|
||
Have an idea for a new feature or improvement? We encourage you to discuss it with the community first by opening a [Feature Request](https://github.com/Mangito/FPS/issues) template issue. This way, you can gather feedback and refine your proposal before investing time in development. | ||
|
||
## Contributing Code | ||
|
||
### Development Setup | ||
|
||
1. Fork the [repository](https://github.com/Mangito/FPS/) to your own GitHub account; | ||
2. Clone your fork to your local machine; | ||
3. Set up the Godot project using the Godot 4 version; | ||
4. Create a new branch for your contribution: `git checkout -b 123-my-issue-title`, [check here for branch name convention](https://github.com/Mangito/FPS/wiki/ProjectBestPractices#branch-naming-convention); | ||
5. Make your changes, test them thoroughly, and ensure they adhere to the project's code style; | ||
|
||
### Code Style | ||
|
||
Please follow our [Coding Guidelines/Code Styles](https://github.com/Mangito/FPS/wiki/ProjectBestPractices#code-styles) to maintain consistency in the codebase. We recommend using Godot's scripting language best practices and adhering to the GDScript style guide. | ||
|
||
### Submitting a Pull Request | ||
|
||
1. Ensure your changes are on a feature branch, not the `main` branch; | ||
2. Commit your changes with clear and concise messages, [check here commit message convections](https://github.com/Mangito/FPS/wiki/ProjectBestPractices#commit-message-convections); | ||
3. Push your branch to your GitHub fork: `git push origin 123-my-issue-title`, [check here for branch name convention](https://github.com/Mangito/FPS/wiki/ProjectBestPractices#branch-naming-convention); | ||
4. Create a Pull Request (PR) from your branch to the `main` project repository, [Check here for pull request best practices](https://github.com/Mangito/FPS/wiki/ProjectBestPractices#pull-requests); | ||
6. Our team will review your PR, offer feedback, and merge it if it meets our guidelines; | ||
|
||
## Community and Communication | ||
|
||
We value your feedback and contributions to FPS Game. If you have questions or need help, please don't hesitate to reach out: | ||
|
||
- You can engage in conversations on the [Github Discussions/Forum](https://github.com/Mangito/FPS/discussions); | ||
- Or in [GitHub Issues](https://github.com/Mangito/FPS/issues); | ||
|
||
Thank you for considering contributing to FPS Game. Your help is greatly appreciated, and it will contribute to making our game a success, and you will forever be in our hearts and on the list of contributors. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report bug to help us improve the game | ||
title: 'BUG: ' | ||
labels: bug | ||
assignees: '' | ||
|
||
--- | ||
|
||
<!-- | ||
Write "N/A." If it's not applicable, and "Not tested." if you didn't test | ||
--> | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior: | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Desktop (please complete the following information):** | ||
- OS: [e.g. iOS] | ||
- Browser [e.g. chrome, safari] | ||
- Version [e.g. 22] | ||
|
||
**Smartphone (please complete the following information):** | ||
- Device: [e.g. iPhone6] | ||
- OS: [e.g. iOS8.1] | ||
- Browser [e.g. stock browser, safari] | ||
- Version [e.g. 22] | ||
|
||
**Additional context** | ||
Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
name: Dev issue | ||
about: It's template should be used for the main team! | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Description** | ||
<!-- Describe your idea --> | ||
|
||
**Ref/Images**: | ||
<!-- Add anything that can help visualize your idea --> | ||
|
||
**Dev Notes** | ||
<!-- Add some aditional notes here --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: enhancement | ||
assignees: '' | ||
|
||
--- | ||
|
||
<!-- | ||
Write "N/A." If it's not applicable, and "Not tested." if you didn't test | ||
--> | ||
|
||
**Description**: | ||
<!-- Provide a short and clear description of the feature you'd like to request. --> | ||
|
||
**Benefits**: | ||
<!-- Explain the benefits or improvements that this feature would bring to the game. --> | ||
|
||
**Additional Information**: | ||
<!-- Include any other relevant information or context. --> | ||
|
||
**Ref/Images**: | ||
<!-- Add anything that can help visualize your idea --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
<!-- Read this before opening de PR: https://github.com/Mangito/FPS/wiki/ProjectBestPractices#pull-requests --> | ||
|
||
### Description | ||
|
||
<!-- Describe the purpose of this pull request. | ||
Provide a brief summary of the changes and why they are being made. --> | ||
|
||
### Image/Video | ||
|
||
<!--- If applicable, include an image/gif/video to help illustrate the changes. --> | ||
|
||
### Related Issue | ||
|
||
Closes #ISSUE_NUMBER | ||
|
||
### Does this PR introduce a breaking change? ⚠️ | ||
|
||
- [ ] No | ||
- [ ] Yes <!-- ::WARNING:: If your PR has a breaking change, your commit body message MUST include "BREAKING CHANGE" --> | ||
|
||
<!-- If this PR contains a breaking change, please describe the impact. --> | ||
|
||
### Tests | ||
|
||
- [ ] I tested all game E2E; | ||
- [ ] I just tested some scenes; | ||
- [ ] Not applicable. | ||
|
||
|
||
## Additional Notes | ||
|
||
<!-- Any additional information or context that might be helpful for the reviewers. --> | ||
|
||
--- | ||
|
||
Thank you for your contribution to FPS Game! Your effort is greatly appreciated, and it helps make this project better for everyone. 😄🎮🚀 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
name: Publish wiki | ||
|
||
on: | ||
push: | ||
branches: [main] | ||
paths: [wiki/**, .github/workflows/publish-wiki.yml] | ||
concurrency: | ||
group: wiki | ||
cancel-in-progress: true | ||
permissions: | ||
contents: write | ||
|
||
jobs: | ||
wiki: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- uses: spenserblack/actions-wiki@v0 | ||
with: | ||
# Whatever directory you choose will be mirrored to the GitHub | ||
# .wiki.git. The default is .github/wiki. | ||
path: wiki |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.