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
- Code of Conduct
- I Have a Question
- I Want To Contribute
- Reporting Bugs
- Suggesting Enhancements
- Your First Code Contribution
- Improving The Documentation
- Styleguides
- Commit Messages
- Join The Project Team
This project and everyone participating in it is governed by the Godot Spin Button Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to .
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 (godot, addon, 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.
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 .
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.
This section guides you through submitting an enhancement suggestion for Godot Spin Button, 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 Godot Spin Button users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
-
Fork the Repository: Start by forking the Godot Spin Button GitHub repository to your own GitHub account.
-
Clone the Repository: Clone your fork locally on your machine.
git clone https://github.com/yudinikita/godot-spin-button.git
-
Set Upstream: Add the original repository as an upstream remote.
git remote add upstream https://github.com/yudinikita/godot-spin-button.git
-
Create a Feature Branch: Any new feature or bugfix should be developed in a separate branch.
git checkout -b feature/your-feature-name develop
-
Commit Your Changes: Make your changes and commit them.
git add . git commit -m "Implemented feature X"
-
Push and Create a Pull Request: Push your changes to your fork and create a pull request from there to the original repository.
git push origin feature/your-feature-name
To update, improve, and correct the documentation, you can follow these steps:
- Review the existing documentation and identify areas that need updating, improvement, or correction.
- Make the necessary changes to the documentation, ensuring that the information is accurate, clear, and up-to-date.
- Update any code examples or diagrams to reflect the current state of the project.
- Proofread the documentation to check for any spelling or grammatical errors.
- Test the documentation to ensure that the instructions and explanations are accurate and easy to follow.
- Publish the updated documentation so that it is easily accessible to users.
By following these steps, you can ensure that your documentation is regularly updated, improved, and corrected to provide the best possible support to your users.
Commit messages play an important role in maintaining a clean and organized codebase. They provide a concise summary of the changes made in a commit, making it easier for other developers to understand the purpose and context of the changes.
When writing commit messages, it is recommended to follow the Conventional Commits format. This format provides a standardized way of structuring commit messages, making it easier to generate changelogs and perform automated tasks based on commit history.
By using Conventional Commits , you can ensure that your commit messages are clear, descriptive, and easy to understand. This improves collaboration among team members and helps maintain a high level of code quality.
Remember to include a concise subject line that summarizes the change, followed by a more detailed description (if necessary). Additionally, you can use commit message prefixes to indicate the type of change (e.g., feat, fix, chore, etc.).
By adhering to the Conventional Commits format, you can make the commit history more meaningful and informative, ultimately improving the overall development process.
Are you passionate about coding and want to contribute to an exciting project? Join our project team and be part of a collaborative and innovative development environment.
We are looking for talented individuals who have experience with godot and game development and are eager to work on Godot Spin Button. As a member of our project team, you will have the opportunity to help us improve the project.
To join our team, please send your resume and portfolio to [email protected]. We look forward to hearing from you and working together to create something amazing!
This guide is based on the contributing-gen. Make your own!