Skip to content

Latest commit

 

History

History
51 lines (26 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

51 lines (26 loc) · 2.39 KB

Contributing to nr-funbucks

Thank you for considering contributing to nr-funbucks! We appreciate your interest in helping to improve our project. Please take a moment to review the following guidelines to ensure a smooth contribution process.

Getting Started

To contribute to nr-funbucks, you'll need to fork the repository and clone it to your local machine. Follow these steps:

  1. Fork the repository: Click the "Fork" button in the upper-right corner of the repository page on GitHub. This will create a copy of the repository in your GitHub account.

  2. Clone your fork: Use Git to clone your fork to your local machine. Replace <your-username> with your GitHub username:

git clone https://github.com/<your-username>/nr-funbucks.git

  1. Create a new branch: Before making any changes, create a new branch to work on:

git checkout -b my-feature-branch

Making Changes

When making changes to the codebase, please follow these guidelines:

  • Write clear, concise commit messages using the Conventional Commits format. This helps maintain a clean and organized Git history.

  • Make sure your code follows the project's coding style and conventions.

  • Write descriptive and meaningful pull request (PR) titles and descriptions.

Submitting Changes

Once you've made your changes and committed them to your branch, follow these steps to submit a pull request:

  1. Push your changes: Push your changes to your forked repository:

git push origin my-feature-branch

  1. Create a pull request: Visit the original repository on GitHub and click the "New pull request" button. Choose your branch and fill out the PR description with details about the changes you've made.

  2. Review and collaborate: Your pull request will be reviewed by the maintainers. Be responsive to feedback and address any requested changes.

  3. Merge your pull request: Once approved, your pull request will be merged into the main branch. Congratulations on your contribution!

Code of Conduct

Please note that by contributing to nr-funbucks, you agree to abide by the Code of Conduct. Please be respectful and inclusive in all interactions.

Questions and Support

If you have any questions or need assistance, feel free to open an issue on the repository or reach out to the maintainers directly.

Thank you for your contributions to nr-funbucks!