Thank you for considering contributing to our project! Here are a few guidelines to follow:
If you're new to contributing, here are some steps to help you get started:
-
Familiarize Yourself with the Project: Take some time to review the project's README.md file and explore the repository to understand its purpose, structure, and current contributions.
-
Read the Code of Conduct: We expect all contributors to adhere to our Code of Conduct. Please review it carefully before participating in our community.
-
Read the guide.md file: Navigate to the
guide.md
file in our repository. -
Make Your Contribution: Create a new branch from the
main
branch to make your changes. Write clear, concise code and documentation following the project's coding standards and guidelines. Feel free to add information regarding AI and Ethics. You can update existing categories or create new ones if necessary. -
Submit Your Contribution: When you're ready, submit your contribution by opening a pushing against the
main
branch or by making a Pull Request (PR). Provide a descriptive title and description for your PR, explaining the changes you've made and why they're valuable. Be prepared to respond to feedback and iterate on your contribution if necessary. -
Celebrate Your Contribution: Congratulations on making your first contribution! Your contributions help improve the project for everyone in the community. We appreciate your efforts and look forward to seeing more contributions from you in the future.
- If you're contributing media content like images or videos related to AI and Ethics, place them in the
media/AI/
directory. - Follow naming conventions reflecting the content.
- Use common formats for images (e.g., JPEG, PNG, SVG) and preferred formats for videos (e.g., MP4, WebM).
- Provide proper attribution for external content.
- Optimize media files for web use while maintaining visual clarity.
- Commit your changes using
git commit -m "Descriptive message about your changes"
. - Ensure your commit messages are consistent with your changes. Refer to Robert Painsi Commit Message Guidelines for more guidance.
- As a collaborator, you do not have to create a pull request. You can push any changes directly to the repository.
- If you're not a collaborator, check the
README.md
file for information on how to submit changes.
- Provide references for any data included in your contributions to maintain credibility.
- Ensure proper citation formatting according to academic or project standards.
Here are some additional resources to help you on your journey as a contributor:
- GitHub Guides - Learn how to use GitHub effectively for collaboration and version control.
- Open Source Guides - Explore resources and best practices for contributing to open source projects.
- Markdown Guide - Learn Markdown syntax for formatting text in README.md files, issues, and pull requests.
- We expect all contributors to adhere to our Code of Conduct in all interactions within our community.
- If you need assistance or have any questions, feel free to reach out to us via email or by opening an issue.