When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. Please note we have a code of conduct, please follow it in all your interactions with the project.
To get started, you will need to have git installed locally. Once you have git and are sure you have all of the necessary dependencies, it's time to create a fork. Before getting started, it is recommended to configure git so that it knows who you are:
git config --global user.name "J. Random User"
git config --global user.email "[email protected]"Fork the project on GitHub and clone your fork locally.
git clone [email protected]:username/octicons-modular.git
cd octicons-modular
git remote add upstream https://github.com/hiendv/octicons-modular.git
git fetch upstreamAs a best practice to keep your development environment as organized as possible, create local branches to work within. These should also be created directly off of the master branch.
git checkout -b fix-something -t upstream/masterThe vast majority of Pull Requests opened against the hiendv/octicons-modular repository includes changes to either the Javascript code contained in the src directory, the scripts contained in the build directory, the documentation in README.md or tests within the test directory.
If you are modifying code, please be sure to run npm run lint from time to time to ensure that the changes follow the code style guide. For an easier flow, you could run npm run dev for the development process which also contains the file watch.
When you are happy with your changes, run npm run build for the build.
It is a recommended best practice to keep your changes as logically grouped as possible within individual commits. There is no limit to the number of commits any single Pull Request may have, and many contributors find it easier to review changes that are split across multiple commits.
git add my/changed/files
git commitAs a best practice, once you have committed your changes, it is a good idea to use git rebase (not git merge) to synchronize your work with the main repository.
git fetch upstream
git rebase upstream/masterThis ensures that your working branch has the latest changes from hiendv/octicons-modular master.
Bug fixes and features should always come with tests. Looking at other tests to see how they should be structured can also help. The test directory within the hiendv/octicons-modular repository is kinda simple and straightforward. Before submitting your changes in a Pull Request, always run the full test suite with npm test.
Important: To simplify these steps, the test, linting scripts are already included in the build script.
Once you are sure your commits are ready to go, with passing tests and linting, begin the process of opening a Pull Request by pushing your working branch to your fork on GitHub.
git push origin my-branchOnce opened, Pull Requests are usually reviewed within a few days.
You will probably get feedback or requests for changes to your Pull Request. This is a big part of the submission process so don't be discouraged! Some contributors may sign off on the Pull Request right away, others may have more detailed comments or feedback. This is a necessary part of the process in order to evaluate whether the changes are correct and necessary.
To make changes to an existing Pull Request, make the changes to your local branch, add a new commit with those changes, and push those to your fork. GitHub will automatically update the Pull Request.
git add my/changed/files
git commit
git push origin my-branchIt is also frequently necessary to synchronize your Pull Request with other changes that have landed in master by using git rebase:
git fetch --all
git rebase origin/master
git push --force-with-lease origin my-branchIf you happen to make a mistake in any of your commits, do not worry. You can amend the last commit (for example if you want to change the commit log).
$ git add any/changed/files
$ git commit --amend
$ git push --force-with-lease origin my-branchFeel free to post a comment in the Pull Request to ping reviewers if you are awaiting an answer on something.
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
Examples of behavior that contributes to creating a positive environment include:
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
- The use of sexualized language or imagery and unwelcome sexual attention or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [INSERT EMAIL ADDRESS]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4