Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
81 lines (56 loc) · 2.36 KB

CONTRIBUTING.md

File metadata and controls

81 lines (56 loc) · 2.36 KB

Contributing to MinistryPages

Thank you for your interest in contributing to the MinistryPages project! We welcome and appreciate contributions of all kinds, including code, documentation, bug reports, feature requests, and suggestions.

How to Contribute

1. Fork the Repository

  • Click the “Fork” button at the top right of the repository page.
  • Clone your fork to your local machine: 
    git clone https://github.com/<your-username>/ministrypages.git
  • Set up the upstream remote: 
    git remote add upstream https://github.com/ForTheChurch/ministrypages.git

2. Create a Branch

  • Create a new branch for your work: 
    git checkout -b feature/my-feature
  • Use descriptive branch names (e.g. bugfix/login-error, docs/update-readme).

3. Make Your Changes

  • Make your changes in your branch.
  • Follow the code style and conventions used in the project.
  • Write clear, concise commit messages: 
    git commit -m "Fix: corrected login error handling"

4. Test Your Changes

  • Run tests to ensure your changes do not break existing functionality.
  • If you add new features, please write corresponding tests.

5. Push and Submit a Pull Request

  • Push your branch to your fork: 
    git push origin feature/my-feature
  • Go to the original repository and open a Pull Request.
  • Provide a clear description of your changes and reference relevant issues if applicable.

6. Respond to Feedback

  • Collaborators may review your PR and request changes.
  • Please respond to comments and update your PR as needed.

Reporting Issues

If you find a bug or have a feature request:

  1. Check if an issue already exists.
  2. If not, open a new issue.
  3. Provide as much detail as possible, including steps to reproduce, expected behavior, and screenshots if appropriate.

Code Style

  • Write clear, readable, and maintainable code.
  • Use meaningful variable and function names.
  • Document complex logic or algorithms in comments.

Community Standards

  • Be respectful and inclusive to all contributors.
  • Avoid offensive language or behavior.
  • Engage constructively in discussions.

License

By contributing to MinistryPages, you agree that your contributions will be licensed under the repository’s open source license.

Thank you for helping improve MinistryPages!