catholic-resources / CONTRIBUTING.md
Dฦฐฦกng Tiแบฟn Vinh
chore: add data
50b1ce0
|
raw
history blame
1.94 kB

Contributing to This Project

Thank you for your interest in contributing! ๐ŸŽ‰ This project is open to improvements and collaboration. Please follow the guidelines below to ensure a smooth contribution process.

๐Ÿš€ How to Contribute

  1. Fork the repository.
  2. Clone your fork:
    git clone https://github.com/your-username/repository-name.git
    
  3. Create a new branch for your changes:
    git checkout -b feature-or-bugfix-name
    
  4. Make your changes and commit them:
    git commit -m "Add a meaningful commit message"
    
  5. Push to your fork:
    git push origin feature-or-bugfix-name
    
  6. Create a Pull Request (PR) on GitHub and provide a clear description of your changes.

๐Ÿ“Œ Contribution Guidelines

  • Follow the Code of Conduct (if applicable).
  • Keep pull requests small and focused.
  • Write clear commit messages that explain the changes made.
  • Document changes where necessary (e.g., update the README if applicable).
  • Ensure compatibility with the project's existing setup.
  • Run tests before submitting a PR, if applicable.

๐Ÿ›  Issue Reporting

  • Search before posting: Check if the issue has already been reported.
  • Provide detailed information: Include steps to reproduce, screenshots (if applicable), and expected behavior.
  • Suggest possible fixes if you have any ideas.
  • Use clear and concise titles for new issues.

๐Ÿ“ Code Style & Standards

The Basics

  • Follow the existing coding style.
  • Use meaningful variable and function names.
  • Format code consistently.
  • Write self-explanatory and well-structured code.

๐Ÿ’ฌ Need Help?

If you have any questions or need guidance, feel free to:

  • Open an issue on GitHub.
  • Join the discussions section to engage with the community.

We appreciate your contributions! ๐ŸŽ‰