Welcome and thank you for considering contributing to a CIF Unibas Open Lecture.
Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the maintainers and developers managing these open source lectures and projects. In return, we will reciprocate that respect by addressing your issue, assessing changes, and helping you finalize your pull requests.
Contributions are made to this repo via Issues and Pull Requests (PRs). Please search for existing Issues and PRs before creating your own. We work hard to makes sure issues are handled in a timely manner. A friendly ping in the comment thread to the submitter or a contributor can help draw attention.
Issues should be used to report problems with the project, request a new feature, or to discuss potential changes before work is started on a PR. When you create a new Issue, a template will be loaded that will guide you through collecting and providing the information we need to investigate.
If you find an Issue that addresses the problem you're having, please add your own reproduction information to the existing issue rather than creating a new one.
PRs to our projects are always welcome and can be a quick way to get your fix or improvement slated for the next release. In general, PRs should:
- Address a single concern in the least number of changed lines as possible.
- Include detailed commit messages to document the changes.
- Be accompanied by a complete Pull Request template (loaded automatically when a PR is created).
For changes that address core functionality or would require breaking changes (e.g. a major release), it's best to open an Issue to discuss your proposal first. This is not required but can save time creating and reviewing changes.
If your PR exclusively addresses typos, please prefix the commits and the PR with "typo:". Other, optional prefixes for your commits are "fix:" and "feat:" for changes and new features respectively.
In general, we follow the "fork-and-pull" Git workflow
- Fork the repository to your own Github account
- Clone the project to your machine
- Create a branch locally with a succinct but descriptive name
- Commit changes to the branch
- Following any formatting and testing guidelines specific to this repo
- Push changes to your fork
- Open a PR in our repository and follow the PR template so that we can efficiently review the changes.