First off, thanks for taking the time to contribute! ❤️
All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
- Star the project
- Tweet about it
- Refer this project in your project's readme
- Mention the project at local meetups and tell your friends/colleagues
This project and everyone participating in it is governed by the flask_Captchaify Code of Conduct. By participating, you are expected to uphold this code. Remember, information should be free.
If you want to ask a question, we assume that you have read the available Documentation.
Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
If you then still feel the need to ask a question and need clarification, we recommend the following:
- Open an Issue.
- Provide as much context as you can about what you're running into.
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
We will then take care of the issue as soon as possible.
When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. Please refer to the license for details. Don't worry we don't take legal shit seriously.
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
- Make sure that you are using the latest version.
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the documentation. If you are looking for support, you might want to check this section).
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker.
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
- Collect information about the bug:
- Stack trace (Traceback)
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
- Possibly your input and the output
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to mail@tn3w.dev and/or reported on the security page.
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
- Open an Issue. (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
- Explain the behavior you would expect and the actual behavior.
- Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
- Provide the information you collected in the previous section.
Once it's filed:
- The project team will label the issue accordingly.
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as
needs-repro. Bugs with theneeds-reprotag will not be addressed until they are reproduced. - If the team is able to reproduce the issue, it will be marked
needs-fix, as well as possibly other tags (such ascritical), and the issue will be left to be implemented by someone.
Please provide a clear and concise title for your issue.
Please provide a detailed description of your issue.
- Expected Behavior: Please describe what you expect to happen.
- Actual Behavior: Please describe what actually happens.
- Reproduction Steps: Please provide detailed steps to reproduce the issue.
- Error Messages: If you are getting any error messages, please provide them.
- Context: Please provide any relevant information about your setup such as the versions of used libraries and the operating system you are using.
- Screenshots: If applicable, please provide screenshots to help explain the issue.
- Additional Information: If you have any additional information that might be helpful for us to understand the issue, please provide that information.
If you have any additional information that might be helpful for us to understand the issue, please provide that information here.
It is important that you suggest improvements, no one will be offended if you try to incorporate your wishes into this project! This section guides you through submitting an enhancement suggestion for flask_Captchaify, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
- Make sure that you are using the latest version.
- Read the documentation carefully and find out if the functionality is already covered, maybe by an individual configuration.
- Perform a 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.
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
Enhancement suggestions are tracked as GitHub issues.
- 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.
- Describe the current behavior and explain which behavior you expected to see instead and why. At this point you can also tell which alternatives do not work for you.
- You may want to include screenshots and animated GIFs which help you demonstrate the steps or point out the part which the suggestion is related to. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
- Explain why this enhancement would be useful to most flask_Captchaify users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
Before you get started with your first contribution, you should ensure that your development environment is properly set up. This includes your IDE, version control system (we use Git) and package manager (we use pip).
- IDE: Any Python IDE will do, but we recommend Visual Studio Code with the Python extension. This combination allows for a smooth and efficient coding experience.
- Version Control System: Ensure that you have Git installed on your machine. You can install Git from here.
- Package Manager: Make sure that you have pip installed. You can install pip from here.
Now that you have your development environment set up, it's time to clone the repository and start coding! To get started, you can follow these steps:
- Clone the repository: Use the following command to clone the repository to your local machine:
git clone https://github.com/tn3w/flask_Captchaify.git- Create a new virtual environment: Use the following command to create a new virtual environment:
python -m venv venv- Activate the virtual environment: Use the following command to activate the virtual environment:
source venv/bin/activate- Install flask_Captchaify: Use the following command to install flask_Captchaify:
pip install -r requirements.txt- Start coding: You can now start coding in the repository.
There are a few rules you should follow when writing code:
- Use descriptive variable names
- Avoid using single letter variable names
- Follow PEP8 style guide
- Use consistent indentation and spacing
- Use comments to explain complex code
- Remove unused code
Use an Extension like Pylint to check your code.
The documentation is crucial for an project. If you find any errors or outdated information, please don't hesitate to report them and help improve the documentation.
If you find an error, outdated information, typos, or grammatical errors in the documentation, you can submit a pull request to fix it.
- Fork the repository: Create your own fork of the repository on GitHub.
- Make the changes: Make the necessary changes to the documentation.
- Submit a pull request: Submit a pull request to the main repository.
This guide is based on the contributing-gen.