This repository has been archived by the owner on Nov 24, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #97 from Anita-ihuman/main
added contribution guidelines
- Loading branch information
Showing
1 changed file
with
77 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
# Contributing to All In CHAOSS Project badging! | ||
|
||
👍🎉Thank you for your interest in contributing to All In CHAOSS Project 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 ALL In CHAOSS Project Badging and every contribution is equally appreciated. | ||
|
||
Before you get started, please take a moment to read through the following guidelines: | ||
- [Code of Conduct](#code-of-conduct) | ||
- [Who can contribute?](#who-can-contribute?) | ||
- [How to Contribute](#how-to-contribute) | ||
- [Set up your Local Development Environment](#set-up-your-local-development-environment) | ||
- [Code Style and Standards](#code-style-and-standards) | ||
|
||
## Code of Conduct | ||
|
||
Please note that this project has a [Code of Conduct](https://github.com/chaoss/.github/blob/main/CODE_OF_CONDUCT.md). 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 All In 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 All In CHAOSS Project badging: | ||
|
||
1. **Fork the Repository**: Click the "Fork" button in the upper right-hand corner of the All In CHAOSS Project badging repository on GitHub. | ||
|
||
2. **Clone Your Fork**: Clone your fork of the repository to your local machine: | ||
|
||
*git clone https://github.com/your_username/ProjectBadging.git* | ||
|
||
replace `your_username` with your actual github username | ||
|
||
### Set up your Local Development Environment | ||
|
||
3. **Perform the following to get your working environment ready**: | ||
|
||
```bash | ||
cd ProjectBadging # move into project directory | ||
npm install # installs packages and dependencies | ||
``` | ||
|
||
4. **Create a Branch**: Create a new branch for your contribution: | ||
|
||
*git checkout -b your-branch-name* | ||
|
||
5. **Make Changes**: Make your desired changes to the codebase. Ensure your code follows our coding standards and guidelines. | ||
|
||
6. **Test**: Test your changes to ensure they work as expected. | ||
|
||
7. **Commit Changes**: Commit your changes with a clear and descriptive message. | ||
|
||
*git add . | ||
git commit -S -m "<Brief description of your changes>"* | ||
|
||
8. **Push Changes**: Push your changes to your fork on GitHub: | ||
|
||
*git push origin your-branch-name* | ||
|
||
9. Create a Pull Request: Go to the [ALL In CHAOSS Project Badging repository on GitHub and create a new pull request from your fork. Describe your changes and why they should be merged. | ||
|
||
10. **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. | ||
|
||
|
||
11. **Merge**: Once your pull request is approved, it will be merged into the main project. | ||
|
||
|
||
## Code Style and Standards | ||
All In CHAOSS Project 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](https://github.com/AllInOpenSource/ProjectBadging/issues) for All In CHAOSS Project 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 contact get in touch with the project maintainers. | ||
|
||
We appreciate your contributions and look forward to working with you to make ALL In CHAOSS Project Badging even better! |