56 lines
2.8 KiB
Markdown
56 lines
2.8 KiB
Markdown
<h1 style="text-align: center;">How to contribute</h1>
|
|
|
|
First of all, thank you for taking the time to contribute to the EntGamers project!
|
|
|
|
The following is a set of guidelines for contributing to the EntGamers website. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
|
|
|
|
<h2>Table of contents</h2>
|
|
|
|
- [Code of Conduct](#code-of-conduct)
|
|
- [Styleguides](#styleguides)
|
|
- [Git Commit Messages](#git-commit-messages)
|
|
- [Pull Request Messages](#pull-request-messages)
|
|
- [TypeScript](#typescript)
|
|
- [How Can I Contribute?](#how-can-i-contribute)
|
|
- [Reporting Bugs](#reporting-bugs)
|
|
- [Fixing Bugs](#fixing-bugs)
|
|
|
|
## Code of Conduct
|
|
|
|
This project and everyone participating in it is governed by the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
|
|
|
|
## Styleguides
|
|
|
|
### Git Commit Messages
|
|
|
|
This project uses [Commitlint](https://commitlint.js.org/#/) to enforce a consistent commit message format. Please follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification when writing commit messages. This includes merging pull requests.
|
|
|
|
### Pull Request Messages
|
|
|
|
If the pull request fixes an issue, please include the issue number in the description. As with commit messages, please follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
|
|
|
|
- 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
|
|
|
|
### TypeScript
|
|
|
|
This project uses [ESLint](https://eslint.org/) to enforce a consistent code style. Please follow the [StandardJS](https://standardjs.com/) specification when writing TypeScript code.
|
|
|
|
## How Can I Contribute?
|
|
|
|
### Reporting Bugs
|
|
|
|
- Don't open up a GitHub issue if the bug is a security vulnerability in the website, and instead contact us directly at [contacto@entgamers.pro](mailto:contacto@entgamers.pro).
|
|
- Ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/SrJuggernaut/entgamers_pro/issues)
|
|
- If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, steps to reproduce the issue, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.
|
|
|
|
### Fixing Bugs
|
|
|
|
- Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.
|
|
- Fork the repository and create a new branch from `preview`.
|
|
- Make your changes.
|
|
- Ensure the changes pass the linter by running `npm run lint`.
|
|
- Submit a pull request.
|