Skip to content

Latest commit

 

History

History
33 lines (27 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

33 lines (27 loc) · 1.87 KB
Raw

Contributing

Firstly, thank you for taking your time to contribute to Project Nexus. There are many ways to contribute, and all of them are appreciated. For any questions, please reach out to the admin of the repository.

Anyone who wishes to contribute to Project Nexus is expected to:

  • Read the Code of Conduct to ensure a safe, healthy, welcoming and respectful communnity.
  • Create a fork of the repository, and make changes on a new branch.

Ways to contribute:

You can contribute to Project Nexus in the following ways:

  • Report bugs
  • Contribute new ideas for development
  • Enhancing existing features
  • Provide documentation

Pull requests:

Some guidelines to be followed before making pull requests are:

  • Check if the feature / idea proposed already exists, or is being worked on.
  • Report any bugs on the issues section adding the label bug to it.
  • All PRs made are recommended to follow example markdown format mentioned below.
  • A detailed high-level review on all modified files is recommended.
  • Link the pull request made to the corresponding issue.

Markdown template for pull requests:

# Abstract of the pull request?
# Bugs resolved
# Summary of changes
# Authors

For newcomers:

  • The issues labelled with Good First Issue are a good starting point for newcomers to start contributing.

Acknowledgments:

  • Project Nexus contributing guidelines are based on Carbon Language guidelines. Many thanks for providing a basis.