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.
The Computer Engineering Department is excited to see your contributions. 🎉
- Code of Conduct
- I Have a Question
- I Want To Contribute
- Reporting Bugs
- Suggesting Enhancements
- Your First Code Contribution
- Styleguides
- Commit Messages
- Join The Project Team
This project and everyone participating in it is governed by the Boğaziçi University Computer Engineering Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to @doganulus.
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.
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. 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 browser or environment, 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?
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.
This section guides you through submitting an enhancement suggestion for the website, including completely new features and minor improvements to existing functionality. Following these guidelines will help us and the department to understand your suggestion and find related suggestions.
- Make sure that you are using the latest version.
- 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.
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 das users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
We suggest using Visual Studio Code and Devcontainers extension. The repository includes a devcontainer configuration file that will set up a development environment for you. You can find more information about the devcontainer extension here.
The development environment includes the hugo website generator and other helper tools. You can start the development server by running the following command in the terminal:
hugo server --disableFastRenderThis command will start the development server and you can access the website at http://localhost:1313 by default. You can see your local changes in real-time. Please check your changes using the development server before submitting a pull request.
Please start the commit message with a verb in the present tense. The first line should be a short description of the change. If you need more space, you can add a blank line and then a more detailed description. Use the imperative mood in the subject line. For example, use "Add feature" instead of "Added feature".
We hire student assistants each semester to assist with web-related tasks, including triaging and managing contributions for this repository. Contact @doganulus to learn more and apply.
This guide is based on the contributing-gen. Make your own!