This repository was archived by the owner on Jun 9, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Contribution Guidelines
Herta Calvo-Faugier edited this page Apr 24, 2019
·
4 revisions
We want to make contributing to StoryHop as easy and transparent as possible, so we have included guidelines on how to:
- Report bugs
- Submit a bug fix
- Propose/request new features
We use our GitHub repository to host code, track issues and feature requests, and accept pull requests.
We use the StoryHop Community Discord for other community discussions.
We use GitHub Flow, so Pull Requests are used to propose any and all changes to the codebase.
To submit changes, follow these steps:
- Fork the repository and create your branch for
master. - If you've added code, make sure you test it.
- If you've changed code structure, update the documentation.
- Make sure the code and documentation changes adhere to the StoryHop Style Guide.
- Issue a pull request, make sure you explain any changes made.
Bugs are tracked on our repository's Issue Tracker. Make sure your bug reports include:
- A quick summary and/or background
- Steps to reproduce
- Be specific: list any user actions, commands, etc.
- What the expected outcome was
- What actually happened
- Any relevant attachments that show the bug "in action":
- Screenshots, screen recordings, bash output, etc.
By contributing to StoryHop, you agree that your contributions are licensed under GPL v3
StoryHop is an RCOS project, developed under the supervision and guidance of the CSCI-49XX course.