Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

57 lines (38 loc) · 2.82 KB
Raw

🐺 Contributing to Werewolves Assistant Web

Thank you for your interest in contributing to the Werewolves Assistant Web project ❤️! Here are some guidelines to help you get started.

🛠 How to Contribute️

🐛 Reporting Bugs

  • Ensure the bug was not already reported by searching on GitHub under 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, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

💡Suggesting Enhancements

  • Before suggesting an enhancement, please check if it’s already being discussed in an open issue.
  • If you find no issue addressing your idea, open a new issue. Describe the enhancement you'd like to see, why you think it would be beneficial to the project, and any relevant examples.

🚀 Pull Requests

  • All pull requests (PRs) must be created against the develop branch.
  • Fork the repository and create your branch from develop.
  • If you've added code that should be tested, add tests. Coverage should not decrease.
  • Ensure the test suite passes.
  • Follow the style guidelines.
  • If you are making a substantial change, please open an issue first to discuss the change and ensure it is in line with the project's goals.

✨ Coding Standards

  • Follow the coding style of the project.
  • Write clear and descriptive commit messages. It must be in English.
  • Do not add comments in any kind : the code should be self-explanatory.

📝 Commit Messages

  • 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 fewer.
  • Reference issues and pull requests liberally after the first line.

🌟 Git Workflow

  1. Fork the repository.
  2. Clone your fork: git clone https://github.com/your-username/werewolves-assistant-web-next.git.
  3. Create a new branch from develop: git checkout -b my-feature-branch. You can also use the script pnpm run script:create-branch to create a new branch.
  4. Make your changes.
  5. Push to your fork and submit a pull request against the develop branch: git push origin my-feature-branch.

📜 Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [antoine.zanardi@epitech.eu].

📚 Additional Resources

Thank you for contributing! 🎉