Looking to contribute something to Logicytics? Here's how you can help.
Please take a moment to review this document to make the contribution process easy and effective for everyone involved.
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.
The issue tracker is the preferred channel for bug reports and features requests and submitting pull requests, but please respect the following restrictions:
-
Please Do not derail or troll issues. Keep the discussion on topic and respect the opinions of others.
-
Please Do not post comments consisting solely of "+1" or "👍 ". Use GitHub's "reactions" feature instead. We reserve the right to delete comments which violate this rule.
I will be looking at the open issues, analyse them, and provide guidance on how to proceed.
Issues can be assigned to anyone other than me and contributors are welcome to participate in the discussion and provide their input on how to best solve the issue, and even submit a PR if they want to.
Please wait that the issue is ready to be worked on before submitting a PR. We don't want to waste your time.
Please keep in mind that I am a human and have limited resources and am not always able to respond immediately. I will try to provide feedback as soon as possible, but please be patient.
If you don't get a response immediately, it doesn't mean that we are ignoring you or that we don't care about your issue or PR. We will get back to you as soon as we can.
If you decide to pull a PR or fork the project, keep in mind that you should only add/edit the scripts you need to, leave core files alone.
When making modifications to the Logicytics project, please adhere to the following guidelines on the Wiki page.
Our bug tracker utilizes several labels to help organize and identify issues.
For a complete look at our labels, see the project labels page.
A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful!
Guidelines for bug reports:
-
Use the GitHub issue search — check if the issue has already been reported.
-
Check if the issue has been fixed — try to reproduce it using the latest
main(orversionbranch if the issue is about a version) in the repository.
A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? Do other browsers show the bug differently? What would you expect to be the outcome? All these details will help people to fix any potential bugs.
Feature requests are welcome. But take a moment to 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. Please provide as much detail and context as possible.
Good pull requests—patches, improvements, new features—are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code, porting to a different language), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project. For trivial things, or things that don't require a lot of your time, you can go ahead and make a PR.
Please adhere to the coding guidelines used throughout the project (indentation, accurate comments, etc.) and any other requirements (such as test coverage).
View the Wiki for more information on how to write pull requests.
IMPORTANT: By submitting a patch, you agree to allow the project owners to license your work under the terms of the License
By contributing your code, you agree to license your contribution under the MIT License. By contributing to the documentation, you agree to license your contribution under the Creative Commons Attribution 3.0 Unported License.
You also agree to the Developer Certificate of Origin.
- Issues: Use GitHub issues for bug reports and feature requests. Keep the discussion focused and relevant.
- Pull Requests: Use pull requests to propose changes. Be prepared to discuss your changes and address any feedback.
If you have any questions or need further clarification, please feel free to contact me.
Thank you for your contributions!