Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (53 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

62 lines (53 loc) · 2.82 KB

StudyPal Project Guidelines

Purpose

The StudyPal project aims to provide a comprehensive platform for students to enhance their learning experience. This document outlines the guidelines to be followed by the project contributors to ensure a smooth development process.

Contribution Guidelines

  1. Fork the repository and create a new branch for your feature or bug fix.
  2. Write clean and readable code following the project's coding conventions.
  3. Provide clear and concise commit messages.
  4. Submit a pull request to the main repository for review.
  5. Respond to the feedback and address any requested changes.

Contribution

  1. Visit the StudyPal project repository on GitHub at repository-link.
  2. Click on the "Fork" button in the top-right corner of the repository page to create a copy of the repository in your GitHub account.
  3. Clone the forked repository to your local machine using a Git client or the command line:
git clone https://github.com/your-username/studypal.git
  1. Create a new branch for your contribution:
git checkout -b feature/my-feature
  1. Make the necessary changes and commit them to your branch:
git add .
git commit -m "Add my feature"
  1. Push the changes to your forked repository:
git push origin feature/my-feature
  1. Go to the original StudyPal repository on GitHub and create a pull request from your branch.
  2. Provide a clear description of your changes and submit the pull request.
  3. Respond to the feedback and address any requested changes during the review process.
  4. Once your pull request is approved, your changes will be merged into the main repository.

Coding Conventions

  • Use consistent indentation (preferably 2 spaces) for code readability.
  • Follow the JavaScript coding style guide recommended by the project.
  • Use meaningful variable and function names.
  • Add comments to explain complex or non-obvious code sections.

Issue Tracking

  • Use the issue tracker to report bugs, suggest new features, or discuss improvements.
  • Clearly describe the problem or enhancement you are addressing.
  • Provide steps to reproduce the issue if applicable.
  • Assign appropriate labels and milestones to the issues.

Code of Conduct

The StudyPal project adheres to a code of conduct to ensure an inclusive and respectful environment for all contributors. We expect everyone to follow these guidelines:

  1. Be respectful and considerate towards others.
  2. Do not engage in harassment, discrimination, or offensive behavior.
  3. Foster an inclusive and welcoming community.
  4. Avoid personal attacks or insults.
  5. Collaborate and communicate constructively.

If you encounter any violations of the code of conduct, please report them to the project maintainers.

License

The StudyPal project is licensed under the MIT License.