👍🎉 First off, thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to libhttpserver. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
I don't want to read this whole thing, I just have a question!!!
This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
Note: Please don't file an issue to ask a question. You'll get faster results by using the resources below.
We have an official community board where the community chimes in with helpful advice if you have questions.
This section guides you through submitting a bug report for libhttpserver. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.
Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.
Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
- Try to debug the problem You might be able to find the cause of the problem and fix things yourself. Most importantly, check if you can reproduce the problem in the latest version of libhttpserver (head on github).
- Perform a cursory search to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.
Bugs are tracked as GitHub issues. After you followed the steps above, create an issue and provide the following information by filling in the template.
Explain the problem and include additional details to help maintainers reproduce the problem:
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible. When listing steps, don't just say what you did, but explain how you did it.
- Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
- Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
- Explain which behavior you expected instead and why.
- If you're reporting a crash, include a crash report with a stack trace from the operating system. Include these in the issue in a code block, a file attachment, or put it in a gist and provide link to that gist.
- **Consider attaching a simple snipped reproducing the problem. **
- If the problem is related to performance or memory, include a CPU profile capture with your report.
Provide more context by answering these questions:
- Did the problem start happening recently (e.g. after updating to a new version of libhttpserver) or was this always a problem?
- If the problem started happening recently, can you reproduce the problem in an older version of libhttpserver? What's the most recent version in which the problem doesn't happen? You can download older versions of libhttpserver from the releases page.
- Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.
Include details about your configuration and environment:
- Which version of libhttpserver are you using?
- **What's the name and version of the OS you're using (e.g. "uname -a" on linux) **?
- **What's the version of libmicrohttpd that you have installed? **
- **Have you installed the libraries (both libhttpserver and libmicrohttpd) manually or through package manager? **
- **Which options did you use when compiling? **
- **What compiler version and version of autotools did you use? **
This section guides you through submitting an enhancement suggestion for libhttpserver, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.
Before creating enhancement suggestions, please check this list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible. Fill in the template.
- Perform a cursory search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
Enhancement suggestions are tracked as GitHub issues. Create an issue on that repository and provide the following information:
- Use a clear and descriptive title for the issue to identify the suggestion.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Provide a specific example to demonstrate the new feature.
- Describe the current behavior and explain which behavior you expected instead and why.
- Describe which alternatives you have considered.
- Explain why this enhancement would be useful to most users and why it fits the mission of the library.
Unsure where to begin contributing to libhttpserver? You can start by looking through these beginner and help-wanted issues:
- Beginner issues - issues which should only require a few lines of code, and a test or two.
- Help wanted issues - issues which should be a bit more involved than
beginnerissues.
Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have.
The process described here has several goals:
- Maintain libhttpserver's quality
- Fix problems that are important to users
- Engage the community in working toward the best possible solution
- Enable a sustainable system for maintainers to review contributions
Please follow these steps to have your contribution considered by the maintainers:
- Follow all instructions in the template
- Follow the styleguides
- After you submit your pull request, verify that all status checks are passing
What if the status checks are failing?
If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.
While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.
- Limit the first line to 80 characters or less.
- Add a concise description of what your change does.
- Reference issues and pull requests liberally after the first line.
- Use Markdown.
This section lists the labels we use to help us track and manage issues and pull requests.
GitHub search makes it easy to use labels for finding groups of issues or pull requests you're interested in. We encourage you to read about other search filters which will help you write more focused queries.
The labels are loosely grouped by their purpose, but it's not required that every issue have a label from every group or that an issue can't have more than one label from the same group.
Please open an issue on etr/libhttpserver if you have suggestions for new labels.
| Label name | etr/libhttpserver 🔎 |
Description |
|---|---|---|
feature-request |
search | Feature requests or enhancements. |
bug |
search | Confirmed bugs or reports that are very likely to be bugs. |
question |
search | Questions more than bug reports or feature requests (e.g. how do I do X). |
feedback |
search | General feedback more than bug reports or feature requests. |
help-wanted |
search | The maintainer would appreciate help from the community in resolving these issues. |
beginner |
search | Less complex issues which would be good first issues to work on for users who want to contribute to libhttpserver. |
more-information-needed |
search | More information needs to be collected about these problems or feature requests (e.g. steps to reproduce). |
needs-reproduction |
search | Likely bugs, but haven't been reliably reproduced. |
blocked |
search | Issues blocked on other issues. |
duplicate |
search | Issues which are duplicates of other issues, i.e. they have been reported before. |
wontfix |
search | The maintainers have decided not to fix these issues for now, either because they're working as intended or for some other reason. |
invalid |
search | Issues which aren't valid (e.g. user errors). |
| Label name | etr/libhttpserver 🔎 |
Description |
|---|---|---|
windows |
search | Related to Windows. |
linux |
search | Related to Linux. |
mac |
search | Related to macOS. |
travis |
search | Related to travis and CI in general. |
tests |
search | Related to tests (add tests, fix tests, etc...). |
documentation |
search | Related to any type of documentation. |
performance |
search | Related to performance. |
security |
search | Related to security. |
api |
search | Related to libhttpserver's public APIs. |
git |
search | Related to Git functionality (e.g. problems with gitignore files or with showing the correct file status). |
| Label name | etr/libhttpserver 🔎 |
Description |
|---|---|---|
work-in-progress |
search | Pull requests which are still being worked on, more changes will follow. |
needs-review |
search | Pull requests which need code review, and approval from maintainers. |
under-review |
search | Pull requests being reviewed by maintainers. |
requires-changes |
search | Pull requests which need to be updated based on review comments and then reviewed again. |
needs-testing |
search | Pull requests which need manual testing. |