👍🎉 First off, thanks for taking the time to contribute! 🎉👍
This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.
Before Submitting A Bug Report
- Check the debugging guide
- Check if the issue has already been reported
- Collect information about the bug:
- Stack trace
- OS and version
- Python version
- Steps to reproduce
How Do I Submit A (Good) Bug Report? Create an issue using the bug report template.
Before Submitting An Enhancement
- Check if there's already a similar feature request
- Determine which repository the enhancement should be suggested in
- Perform a cursory search to see if the enhancement has already been suggested
- Follow all instructions in the template
- Follow the styleguides
- After you submit your pull request, verify that all status checks are passing
- 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
- Reference issues and pull requests liberally after the first line
- Consider starting the commit message with an applicable emoji:
- 🎨
:art:when improving the format/structure of the code - 🐎
:racehorse:when improving performance - 📝
:memo:when writing docs - 🐛
:bug:when fixing a bug - 🔥
:fire:when removing code or files
- 🎨
- Follow PEP 8
- Use type hints
- Write docstrings for all public methods
- Use meaningful variable names
- Use Markdown
- Reference functions and classes in backticks: `func()`
- Document all functions and classes
| Label name | Description |
|---|---|
bug |
Confirmed bugs or reports that are very likely to be bugs |
enhancement |
Feature requests |
documentation |
Documentation improvements |
good first issue |
Good for newcomers |
help wanted |
Extra attention is needed |
- Join our Discord community
- Check out the documentation
- Email us at support@wellcode.ai