Skip to content

Latest commit

 

History

History
52 lines (42 loc) · 3.8 KB

Contributing.md

File metadata and controls

52 lines (42 loc) · 3.8 KB
Raw

Contributing Guidelines for the EU-CS Platform Repository

Thank you for your interest in contributing to the EU-CS Platform project! We appreciate your efforts and look forward to collaborating with you. To ensure a smooth and efficient contribution process, please review and follow the guidelines outlined below.

Table of Contents

  1. Code of Conduct
  2. Getting Started
  3. Reporting Bugs and Feature Requests
  4. Submitting Changes
  5. Code Quality and Standards
  6. Testing and Continuous Integration
  7. Documentation

Code of Conduct

All contributors are expected to adhere to our Code of Conduct, which promotes a respectful, professional, and constructive environment. Harassment, discrimination, or other inappropriate behavior will not be tolerated.

Getting Started

  1. Fork the EU-CS Platform repository to your GitHub account.
  2. Clone the forked repository to your local machine.
  3. Set up the development environment following the instructions provided in the README file.

Reporting Bugs and Feature Requests

  1. Check the Issues to see if the bug or feature request has already been reported.
  2. If the issue doesn't exist, create a new issue using the appropriate template (bug report or feature request).
  3. Be as detailed as possible in your issue description, including steps to reproduce the bug, expected behavior, and any relevant error messages or screenshots.

Submitting Changes

  1. Before making any changes, ensure that you are working on the latest version of the main branch.
  2. Create a new feature branch for your changes using a descriptive naming convention (e.g., feature/username-description or bugfix/username-description).
  3. Make your changes in the new branch, adhering to the Code Quality and Standards guidelines.
  4. Test your changes thoroughly and ensure all tests pass.
  5. Commit your changes using concise, clear commit messages that follow a standard format.
  6. Push your branch to your forked repository.
  7. Create a pull request (PR) to the main repository, providing a clear title and description of your changes, including any relevant issue numbers.
  8. Address any feedback from the code review process and make any necessary changes.

Code Quality and Standards

  1. All Python code must follow PEP 8, the Python style guide, and be checked with Pylint.
  2. HTML and CSS should follow the W3C's HTML and CSS standards.
  3. JavaScript code should follow the Airbnb JavaScript Style Guide.
  4. Django best practices should be followed, including the use of class-based views, the DRY principle, and proper app and model design.

Testing and Continuous Integration

  1. All code should be tested before submitting a PR, and tests should be included in the PR when adding or modifying functionality.
  2. Travis CI is used for continuous integration, and the .travis.yml configuration file should be properly set up to run tests, build processes, and any necessary checks.
  3. PRs must pass all Travis CI checks before being approved and merged.

Documentation

  1. All code should be well-documented with clear comments and meaningful variable/function names.
  2. Project documentation should be maintained, including README files, API documentation, and any necessary user or developer guides.

By followingthese guidelines, you will help foster a productive, organized, and collaborative development environment, ensuring the highest quality code and efficient progress on the EU-CS Platform project. We look forward to working together and making a positive impact!