Skip to content

Latest commit

 

History

History
136 lines (97 loc) · 6.29 KB

CONTRIBUTING.md

File metadata and controls

136 lines (97 loc) · 6.29 KB
Raw

Contributing to DEI CHAOSS Badging!

👍🎉Thank you for your interest in contributing to DEI CHAOSS Badging! 🎉👍

We are beyond excited to see that you want to contribute! and we welcome all contributions to help make this project even better. There are many ways in which one could contribute to the DEI CHAOSS Badging and every contribution is equally appreciated.

Before you get started, please take a moment to read through the following guidelines:

Code of Conduct

Please note that this project has a Code of Conduct. We expect all contributors to adhere to it. Please take a moment to read through these guidelines to ensure a positive and inclusive contributor experience.

Who can contribute?

The DEI CHAOSS Badging initiative is built by the community and warmly welcomes collaboration. So anyone can contribute to this project.

How to Contribute

Here are the steps to follow to contribute to DEI CHAOSS Badging:

  1. Fork the Repository: Click the "Fork" button in the upper right-hand corner of the DEI CHAOSS Badging repository on GitHub. screenshot showing the fork button

  2. Clone Your Fork: Clone your fork of the repository to your local machine:

    git clone https://github.com/your_username/badging.git

    replace your_username with your actual github username

Set up your Local Development Environment

  1. Perform the following to get your working environment ready:

       cd badging # move into project directory
   npm install # installs packages and dependencies

  2. Create a Branch: Create a new branch for your contribution:

    git checkout -b your-branch-name

  3. Make Changes: Make your desired changes to the codebase. Ensure your code follows our coding standards and guidelines.

  4. Test: Test your changes to ensure they work as expected. You may need to create a .env file with values from the .env.example file. e.g, if you want to connect to an API, create a .env file with values as shown below.

       API_BASE_URL = <replace with string of your local or remote api endpoint>

    once that is done, you can test some of your changes locally in development mode by running;

    npm run dev

  5. Commit Changes: Commit your changes with a clear and descriptive message.

    git add .
git commit -S -m "<Brief description of your changes>"

  6. Push Changes: Push your changes to your fork on GitHub:

    git push origin your-branch-name

  7. Create a Pull Request: Go to the ALL In CHAOSS Badging repository on GitHub and create a new pull request from your fork. Describe your changes and why they should be merged.

  8. Review and Discussion: Your pull request will be reviewed by the maintainers and the community. Be prepared for feedback and be responsive to any suggested changes.

  9. Merge: Once your pull request is approved, it will be merged into the main project.

Code Style and Standards

CHAOSS Badging follows a specific code style and coding standards. Please make sure to adhere to these standards when contributing.

Issue Tracking

If you're looking for ways to contribute but don't have specific code changes in mind, you can check the issue tracker for All In CHAOSS Badging on GitHub. You might find issues marked as "help wanted" or "good first issue."

Ask for help If you have any questions or need assistance with your contribution, please get in touch with any of the following project maintainers:

We appreciate your contributions and look forward to working with you to make ALL In CHAOSS Badging even better!

Community Resources

Badging

CHAOSS

Technical Resources

Git & GitHub

Testing