Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (47 loc) · 2.08 KB

CONTRIBUTING.md

File metadata and controls

70 lines (47 loc) · 2.08 KB

Contributing to S.E.S.

Thank you for considering contributing to the S.E.S. project! We welcome all contributions that help improve the project.

How to Contribute

1. Fork and Clone the Repository

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine: 
    git clone https://github.com/your-username/Student_Exam_Generator_And_Analyzer.git
cd Student_Exam_Generator_And_Analyzer
  3. Add the main repository as an upstream remote: 
    git remote add upstream https://github.com/FurkanHuman/Student_Exam_Generator_And_Analyzer.git

2. Create a Branch

Create a new branch for your feature or fix:

git checkout -b feature/your-feature-name

3. Follow Coding Guidelines

  • Maintain code readability and consistency.
  • Write clear and concise commit messages following the Semantic Commit Messages guidelines.

4. Commit Changes

Ensure your commit messages follow the Semantic Commit Messages format. Example:

feat(auth): add JWT authentication
fix(api): resolve timeout issue in data fetching

5. Push and Open a Pull Request

  1. Push your branch to your forked repository: 
    git push origin feature/your-feature-name
  2. Open a Pull Request (PR) to the main branch of the original repository.
  3. Add a meaningful description explaining your changes.

6. Code Review

  • Your PR will be reviewed by maintainers.
  • Please make requested changes if necessary.

Reporting Issues

If you find a bug or have a suggestion, please open an issue following these guidelines:

  • Describe the problem clearly.
  • Provide steps to reproduce it.
  • Suggest possible solutions if applicable.
  • For more detailed information checkout Bug Report Guideline.

License

By contributing, you agree that your contributions will be licensed under the project's LICENSE.

Thank you for your contribution! 🚀