Skip to content

Latest commit

 

History

History
97 lines (68 loc) · 3.34 KB

CONTRIBUTING.md

File metadata and controls

97 lines (68 loc) · 3.34 KB

Contribute to Rerum Playground

Thank you for considering contributing to Rerum Playground! We appreciate your interest in improving the project. Below are some guidelines to help you make the most out of your contribution.

Getting Started

1. Fork the Repository

  • Navigate to the Rerum Playground repository on GitHub.
  • Click the Fork button in the top-right corner to create a personal copy of the repository.

2. Clone Your Fork

  • Clone the repository to your local machine: 
    git clone https://github.com/oss-slu/rerum_playground.git

3. Create a New Branch

  • Create a new branch for your contribution: 
    git checkout -b feature-branch

4. Set Up Your Environment

  • The code base is in HTML, CSS, JS so there is no seperate software installation is requred. Just run the code it will open and renders in your default browser. Use the live server extention if needed.

Contribution Workflow

1.Choose an Issue from issue board

  • Choose the Issue and clearly read all the details and acceptance criteria for the issue before starting to work on the issue.

2. Make Your Changes

  • Work on your branch locally. Implement your changes and test them thoroughly to ensure they work correctly.
  • For any UI changes, please include screenshots in the pull request.

3. Commit Your Changes

  • Commit messages should be clear and concise. Follow the format: 
    git commit -m "Subject and Body"
  • Make sure your commit is properly documented and explains the why and what of the changes.

4. Push Your Changes

  • Push your branch to GitHub: 
    git push origin feature-branch

5. Submit a Pull Request (PR)

  • Navigate to your fork on GitHub and click the Pull Request button.
  • Ensure your PR:
    • References the related issue number (e.g., Fixes #123).
    • Provides a clear description of what was changed and why.
    • Includes relevant tests or screenshots where applicable.
    • follow the Pull Request template.

Code Guidelines

1. Style Guide

  • Keep your code readable, maintainable, and well-documented.

2. Testing Your Changes

  • Test your changes to ensure that they work on Windows and Mac.
  • Run the provided tests, and ensure no existing functionality breaks.

3. Documentation

  • Update documentation as necessary. If your change impacts functionality, be sure to update the corresponding documentation in the JSON Document or README files.

Issue Reporting

1. Submitting a Bug Report

  • Use the Issues section on GitHub to report bugs. When reporting a bug, please provide:
    • A clear description of the issue.
    • Steps to reproduce the bug.
    • Relevant logs, screenshots, or files if applicable.

2. Suggesting Enhancements

  • If you have ideas for new features, improvements, or optimizations, submit them through a GitHub issue and tag it with suggestanissue.

Code of Conduct

All contributors are expected to follow the Code of Conduct in all interactions related to this project. Please be respectful and considerate.

Community

Thank you for your contributions!