This project follows specific guidelines for development, ensuring consistency and compatibility. It is intended to be interpreted or compiled on Ubuntu 14.04 LTS using Python 3.4.3. The allowed editors are vi, vim, and emacs.
To ensure proper execution and adherence to coding standards, the following requirements must be met:
Operating System: Ubuntu 14.04 LTS Python: Version 3.4.3 Editors: vi, vim, emacs File Ending: All files must end with a new line. Shebang Line: The first line of all files should be exactly #!/usr/bin/python3. README.md: A README.md file, located at the root of the project folder, is mandatory. Documentation: Code should be appropriately documented for clarity and understanding. PEP 8 Style: Code should adhere to the PEP 8 style guide (version 1.7.x). File Execution: All files must be executable.
Follow these steps to set up and run the project:
1 - Clone the Repository:
git clone https://github.com/your-username/project-name.git
cd project-name
2 - Ensure Python Version: Ensure that Python 3.4.3 is installed on your system.
3 - Editors: Choose from vi, vim, or emacs to edit project files.
4 - File Permissions: Ensure that all files are executable. If not, set the executable permission using:
chmod +x filename.py
5 - Run the Project: Execute the main script or entry point of your project.
./main.py
Contributions to the project are welcome. Follow these guidelines for contributing:
- Fork the repository and clone your fork locally.
- Make changes following the specified requirements.
- Document your code and ensure adherence to PEP 8.
- Submit a pull request with a clear description of your changes.
- Adhere to PEP 8 style guide (version 1.7.x).
- Document your code for clarity and maintainability.
- Use the allowed editors: vi, vim, emacs.
- Include the shebang line #!/usr/bin/python3 at the beginning of all files.
- Ensure all files end with a new line.
- Maintain executable permissions for all files.