Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

49 lines (34 loc) · 2.68 KB
Raw

Contribution Guidelines

Thank you for considering contributing to the RedBox Portal! We welcome contributions from everyone and are grateful for any help you can provide. These guidelines help communicate how best to contribute to this project and ensure a transparent and collaborative environment.

Code of Conduct

Our project adheres to a Code of Conduct that we expect all contributors to follow. Please read the full text so that you can understand what actions will and will not be tolerated.

Getting Started

  • Fork the repository on GitHub.
  • Clone your forked repository to your local machine.
  • Configure the upstream repo (git remote add upstream https://github.com/redbox-mint/redbox-portal.git).
  • Create a new branch for your contributions (git checkout -b new-feature).
  • Make your changes locally and commit them in logical units to your branch.

Making Changes

  • Write clear and concise commit messages describing your changes.
  • Make sure your code adheres to the existing style to maintain the project's consistency.
  • Reference any relevant issues or external documents in your commit message.
  • Ensure that your changes do not break any existing functionality.
  • Add or update tests as necessary based on your changes.
  • Run all the tests to ensure nothing else was accidentally broken.

Submitting Changes

  • Push your changes to your fork (git push origin new-feature).
  • Submit a pull request to the original repository.
  • Provide a clear description of the problem and solution in the pull request.
  • Link any relevant issues in the pull request description.

Review Process

  • All submissions, including submissions by project members, require review.
  • We use GitHub's review and comments systems for this.
  • Follow up on feedback provided by the RedBox Portal team members.
  • Continue updating your pull request as needed to address feedback or changes requested.

Additional Resources

Thank you for your contributions to the RedBox Portal project. Your efforts help make our project better and are greatly appreciated!

Note: This is a general template for contribution guidelines. You may need to modify it to fit your project's specific requirements and workflow.