😅 First off, thanks for taking the time to contribute!
We encurage and value all types of contributions. Look at 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 everyone involved.
The community looks forward to your contributions
And if you like ojs-codecheck, but just don't have time to contribute, that's fine. There are other easy ways to support ojs-codecheck, as well as the CHECK-PUB project and the CODECHECK initiative and show your appreciation, which we would also be very happy about:
- Conduct a CODECHECK yourself
- Star the project and share it on social media - we are @codecheck@fediscience.org
- Refer this project in your reserach publications or project websites
- Mention the project at meetups/conferences and tell your friends/colleagues
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 projects Apache-2.0 license.
If you want to contribute to this project, please follow these guidelines:
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Make your changes following the coding standards; optionally open a draft pull request
- Update tests and documentation
- If you've added code that should be tested, add tests
- If you've changed APIs, update the documentation
- Ensure the test suite passes
- Commit your changes (
git commit -m 'Add amazing feature, closes #999') - Push to the branch (
git push origin feature/amazing-feature) - Open a pull request
- Follow PSR-12 coding standards
- Use meaningful variable and speaking function names (long names are fine, function names should have a verb in them)
- Document all public methods and classes
- Maintain backward compatibility within major versions
- Make sure your code lints
- When contributing to the documentation inside the README.md, CONTRIBUTING.md, or CHANGELOG.md, please follow the same rules listed in Contributing to ojs-codecheck
- Instead of creating a feature branch though, please consider creating a documentation branch (
git checkout -b documentation/my-doc-improvement)
If you want to ask a question, we assume that you have read the available documentation inside the README.md,on the CODECHECK and CHECK-PUB websites, as well as the CODECHECK paper.
Before you ask a question, it is best to search for existing issues that might help you. In case you have found a suitable related or connected issue and still need clarification, you can write your question as a comment to 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 steps:
- Open an issue.
- Provide as much context as you can about what you're running into.
- Provide project and platform versions (OJS, PHP, etc.), depending on what seems relevant.
We will then take care of the issue as soon as possible and as good as we can. Please do remind us with a further comment or by contacting us in a different way if we do not get back to you within a month.
Your bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you kindly 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 OJS and/or PHP versions (Make sure that you have read the README.md. 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)
- OJS and PHP versions.
- Possibly your input and the output (if the bug happened, e.g., during CODECHECK metadata creation)
- Can you reliably reproduce the issue, or was it just a one time occurenece?
- Can you reproduce the bug with older versions as well?
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 daniel.nuest@tu-dresden.de.
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 the issue is 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
question. Bugs with thequestionlabel will not be addressed until they are reproduced. - If the team is able to reproduce the issue, it will be marked
bug, as well as possibly other tags (such ashelp wantedor evenenhancement), and the issue will be left to be implemented by someone.
This section guides you through submitting an enhancement suggestion for the ojs-codecheck plugin, 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 of the ojs-codecheck plugin as well as the compatible versions of OJS and PHP - see README.md.
- Read the README.md 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 us 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, as well as features that follow the CHECK-PUB project proposal and the CODECHECK community workflow. If you're just targeting a minority of users, consider marking the issue as such, so we can discuss further, if it is necessary.
Enhancement suggestions are tracked as GitHub issues.
- Please mark your enhancement issue as
enhancement. - 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 (we would appreciate it if you use checkboxes to list possible individual development steps).
- 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 of Mock-Ups which help you demonstrate the steps or point out the part which the suggestion is related to.
- Explain why this enhancement would be useful to most users of the ojs-codecheck plugin. You may also want to point out the other projects that solved it better and which could serve as inspiration.
Please try to keep your commit messages short and concise and mark the issue you are working on in your commit message.
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members
- The use of sexualized language or imagery and unwelcome sexual attention or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
This CONTRIBUTING.md is based on and adapted from the CONTRIBUTING.MD Example as well as the Contributing to Transcriptase and Good Contributing.md templates.