Skip to content

Latest commit

 

History

History
86 lines (60 loc) · 3.86 KB

Contribution.md

File metadata and controls

86 lines (60 loc) · 3.86 KB
Raw

Contributing to Scholar Station 🎓✨

First off, thank you for considering contributing to Scholar Station! 🙌 It's people like you that make Scholar Station such a great tool for students worldwide.

Table of Contents

Code of Conduct 📜

This project and everyone participating in it is governed by the Scholar Station Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to project_email@example.com.

How Can I Contribute? 🤔

Reporting Bugs 🐛

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements 💡

  • Open a new issue with your suggestion.
  • Provide a clear and detailed explanation of the feature you want and why it's important to add.
  • Include code samples and screenshots if applicable.

Your First Code Contribution 🎉

Unsure where to begin contributing to Scholar Station? You can start by looking through these beginner and help-wanted issues:

  • Beginner issues - issues which should only require a few lines of code, and a test or two.
  • Help wanted issues - issues which should be a bit more involved than beginner issues.

Getting Started 🚀

  1. Fork the repo on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/your-username/scholar-station.git
  3. Create a new branch: 
    git checkout -b name-of-your-bugfix-or-feature
  4. Make your changes locally.
  5. Commit your changes: 
    git commit -m "Your detailed description of your changes."
  6. Push your branch to GitHub: 
    git push origin name-of-your-bugfix-or-feature
  7. Submit a pull request through the GitHub website.

Pull Request Process 🔄

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
  4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Style Guidelines 📝

Git Commit Messages 💬

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

JavaScript Styleguide ☕️

All JavaScript must adhere to JavaScript Standard Style.

CSS Styleguide 🎨

All CSS must adhere to CSS Guidelines.

Thank You! 💖

Again, thank you for your contribution to Scholar Station. Your time and expertise help make education more accessible and collaborative for students around the world! 🌍📚

go to notes.md for notes contribution