Skip to content

Latest commit

 

History

History
60 lines (34 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

60 lines (34 loc) · 2.18 KB
Raw

Contributing to Magnificent Sloth

Thank you for your interest in contributing to Magnificent Sloth! We welcome contributions from students, CommIT and IT Crowd members to help us improve and grow our projects.

Getting Started

Before you start contributing, please make sure you have:

  1. Created a GitHub account: If you don't have one already, you can sign up here.

  2. Familiarized yourself with Git and GitHub: You may find resources like GitHub's Guide to Git helpful.

  3. Installed Git on your local machine: You can download it from here.

Contributing

To contribute to our projects, please follow these steps:

  1. Clone the Repository: Use git clone to clone the repository to your local machine.
git clone https://github.com/svsticky/magnificent-sloth.git
  1. Switch to a New Branch: Create a new branch for your work and switch to it.
git switch -c feature-name

  1. Make Changes: Make your desired changes to the code or documentation.

  2. Commit Changes: Commit your changes with a descriptive message.

git commit -m "Added feature XYZ"
  1. Push Changes: Push your changes to the project's repository on GitHub.
git push origin feature-name
  1. Create a Pull Request (PR): Go to the original repository on GitHub and click on the "New Pull Request" button. Describe your changes and make sure to mention the related GitHub issue in your description.

Example: "This PR fixes #[issue number]"

  1. Review and Collaboration: Other contributors or maintainers will review your PR. Be prepared to make changes or answer questions.

  2. Merge: Once your PR is approved, it will be merged into the main project.

  3. Documentation: Please consider adding proper documentation to either this repository or the Stickypedia over at wiki.svsticky.nl.

Help and Support

If you have any questions or need assistance, feel free to email the IT Crowd with your questions at itcrowd@svsticky.nl.

We appreciate your contributions and look forward to working with you! 🎉