Skip to content

Latest commit

 

History

History
71 lines (49 loc) · 3.31 KB

CONTRIBUTING.md

File metadata and controls

71 lines (49 loc) · 3.31 KB
Raw

Contributing to CodeX

First of all, thank you for considering contributing to CodeX! We appreciate your enthusiasm and willingness to help make our educational materials even better. As a collaborative project, we value your input and aim to create an open and inclusive environment for all contributors.

This document serves as a guide on how to contribute to CodeX. Please read it carefully before making any contributions.

Table of Contents

How Can I Contribute?

There are several ways you can contribute:

Reporting Bugs

If you encounter any bugs, issues, typos, or incorrect information while using our materials, please report them by creating a new issue on our GitHub repository. Be sure to include as much information as possible about the problem, such as steps to reproduce it, expected behavior, and actual behavior.

When creating a bug report, please:

  1. Use a clear and descriptive title.
  2. Describe the steps needed to reproduce the issue.
  3. Explain what you expected to happen and what actually happened.
  4. Include any relevant error messages, screenshots, or typos.
  5. Mention any related issues or pull requests.

Suggesting Enhancements

We're always looking for ways to improve our materials! If you have an idea for an enhancement, page, or new topic that would benefit the project, please create a new issue on our GitHub repository.

When suggesting an enhancement, please:

  1. Use a clear and descriptive title.
  2. Describe the enhancement in detail, including any benefits or potential challenges.
  3. Explain why you think this enhancement would be useful to others.

Contributions

If you'd like to contribute code or content directly, we welcome your pull requests! Here's how to get started:

  1. Fork the repository on GitHub.
  2. Create a new branch for your changes.
  3. Make your changes in the new branch.
  4. Commit your changes with clear and descriptive commit messages.
  5. Push your changes to your fork on GitHub.
  6. Create a pull request against our main repository.

When creating a pull request, please:

  1. Use a clear and descriptive title that explains the purpose of the changes.
  2. Describe the changes in detail and explain any related issues or existing problems that they address.
  3. Include any relevant screenshots or examples to help illustrate your changes.

Style Guidelines

To ensure consistency across our materials, please follow these style guidelines when contributing:

  • Write in clear, concise language that is easy for readers at various levels of expertise to understand
  • Use proper grammar and punctuation
  • Format code using standard conventions for the programming language or technology being used
  • Provide meaningful comments and explanations within code examples
  • Organize content logically with headings, subheadings, lists, and other formatting as appropriate
  • Use consistent naming conventions for variables, functions, classes, etc.
  • Use admonish for notes or various information the reader should know.

Thank you again for considering contributing to CodeX!