👍🎉 First off, thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to Allegro and its packages. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
New Feature and code contributions
This project and everyone participating in it is governed by the Allegro Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
First, please do a search in open issues to see if the issue or feature request has already been filed.
If you find your issue already exists, make relevant comments and add your reaction:
👍 - upvote
👎 - downvote
If you cannot find an existing issue that describes your bug or feature, submit an issue using the guidelines below.
- Be as clear and concise as possible.
- Do not submit more than one bug in a single issue.
- Clearly explain the following:
- Action taken (what you did)
- Expected result (what you hoped would happen)
- Actual result (unexpected outcome)
- Your setup (any and all relevant technical facts, error messages, logs, etc)
- First consider if you yourself might be able to work on the feature? If so, check out info on contributing code below.
- If you do not have the skills, then please take the time to clearly think through the request. Is is appropriate for all users of Lazarus? If so, create a new issue containing the following:
- Write
[request]as the first item in the title, followed by a short, concise description, eg:[request] Analyze streams. - Fill in details explaining your request. Be as clear and concise as possible and only 1 request at a time.
- Add mock-ups, etc as needed to clearly demonstrate the idea.
Things to take into consideration when submitting a pull request:
- Please submit all pull requests (except for hotfixes) to the develop branch.
- Please keep current code styling in mind (handled with xo).