We're thrilled you're interested in contributing to Howdy! This guide will help you understand how to effectively contribute, whether you're reporting a bug, suggesting an improvement, or submitting code changes.
We have some ground rules to keep the discussion open and inclusive. Before diving in, be sure to review our Code of Conduct to ensure a respectful and collaborative environment.
Check for Existing Issues: Search the existing issues list to see if someone has already reported the bug. Open a New Issue: If you can't find an existing issue, create a new one with a clear and descriptive title. Submitting an Issue
How to submit an issue?
- Navigate to the repository's issue list: First, find the open-source project on GitHub. Then, under the repository name, click on "Issues".
- Initiate a new issue: On the issues page, locate a button labeled "New issue" or something similar. Click on it to begin creating a new issue report.
- Craft a clear and concise title: Provide a simple and informative title that accurately reflects the issue you're encountering. The title should give maintainers a quick understanding of the problem.
- Describe the issue thoroughly: In the issue description, provide a detailed explanation of the problem you've encountered. Here are some pointers for a comprehensive description:
- Steps to reproduce: Outline the exact steps required to replicate the issue. This allows maintainers to efficiently diagnose the problem.
- Expected vs. actual behavior: Describe what you anticipated to happen and what occurred.
- Code snippets and error messages (if applicable): If the issue is related to code, include relevant code snippets and any error messages encountered.
- Screenshots or screencasts (if helpful): For visual issues, screenshots or screencasts can significantly aid understanding.
- Double-check and submit: Once you've meticulously described the issue, proofread your report for clarity and accuracy. When satisfied, submit the issue.
When it comes to documentation, there is always room for improvement.
- Consider Creating an Issue: If your enhancement is a major change, feel free to open an issue to discuss it with the project maintainers. Submit a Pull Request
- Open a Pull Request: For smaller improvements or suggestions, you can create a pull request directly. Submit an Issue
Before submitting a pull request, consider the following guidelines:
- To prevent duplication of work, please search for an existing PR (open or closed) that relates to yours.
- Make sure there is an issue describing your submission, whether it is a bug fix or a feature. Discussing the issue upfront will make the review process much faster.
- Make sure your pull request is addressing only a single concern.
How to submit a pull request?
- Fork the relevant repository.
- Check out a topic branch for your submission.
- Apply your work there. It's fine to have multiple commits. We will make sure to squash it before merging.
- Make sure to add appropriate tests which cover your work.
- Run the test suite of the repository.
- Push your new branch to GitHub.
- Submit a pull request to the master branch.
Once everything is done, your work will be live and available to all Howdy users.
Each repository has its own coding rules and formatters to enforce them when running the tests automatically. To ensure consistency and readability, we use PEP 8 – Style Guide for Python Code for most Python projects.
We follow Angular's commit message guidelines. This leads to more readable messages and automatic changelog generation.
🤠 Thank you for joining our journey! We appreciate your time and effort in making Howdy even better.