Guidelines For Contribution #23
Pinned
Algorithmia-SE-2023
announced in
Announcements
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Dear Algorithmians,
Welcome to the web static project!
We appreciate your contributions, towards making this project successful.
In line with what we have learned and are learning at ALX SE, we need to consciously work to improve the consistency and maintainability of our code, in this project.
Please consider the following major points when contributing:
1. File Structure: Follow the method of contribution being used, sync your forked repos as discussed in this issue, and ensure that your contributions are in the right directories.
2. HTML and CSS_: Follow HTML and CSS best practices. Properly indent your files, use semantic HTML elements, and maintain a clean and organized CSS file. We will be validating our HTML, CSS and JavaScript files with W3C
3. Documentation: Document your contributions using code comments. Add meaningful comments to explain your code.
4. Version Control and Pull Requests: Add an explanation to your pull requests, use proper commit messages, and follow the Git workflow for our contribution.
5. Deadlines: When assigned a task, please work on it, and try the best you can to submit it on or before the deadline.
6. Development Environment: I personally suggest using VSCode for working on your contribution to this project, as it helps with a visual aid when working on the project. However, you could work on this project with what works with you.
Facing Any Issues?
Reach out to the @ALX-SE-Algorithmia/code-reviewing-team team.
Enjoy working on the project.
Best regards,
Dohou Daniel.
Beta Was this translation helpful? Give feedback.
All reactions